1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package types 4 5import ( 6 "time" 7) 8 9// The Amazon Chime account details. An AWS account can have multiple Amazon Chime 10// accounts. 11type Account struct { 12 13 // The Amazon Chime account ID. 14 // 15 // This member is required. 16 AccountId *string 17 18 // The AWS account ID. 19 // 20 // This member is required. 21 AwsAccountId *string 22 23 // The Amazon Chime account name. 24 // 25 // This member is required. 26 Name *string 27 28 // The Amazon Chime account type. For more information about different account 29 // types, see Managing Your Amazon Chime Accounts 30 // (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the 31 // Amazon Chime Administration Guide. 32 AccountType AccountType 33 34 // The Amazon Chime account creation timestamp, in ISO 8601 format. 35 CreatedTimestamp *time.Time 36 37 // The default license for the Amazon Chime account. 38 DefaultLicense License 39 40 // The sign-in delegate groups associated with the account. 41 SigninDelegateGroups []SigninDelegateGroup 42 43 // Supported licenses for the Amazon Chime account. 44 SupportedLicenses []License 45} 46 47// Settings related to the Amazon Chime account. This includes settings that start 48// or stop remote control of shared screens, or start or stop the dial-out option 49// in the Amazon Chime web application. For more information about these settings, 50// see Use the Policies Page 51// (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime 52// Administration Guide. 53type AccountSettings struct { 54 55 // Setting that stops or starts remote control of shared screens during meetings. 56 DisableRemoteControl *bool 57 58 // Setting that allows meeting participants to choose the Call me at a phone number 59 // option. For more information, see Join a Meeting without the Amazon Chime App 60 // (https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html). 61 EnableDialOut *bool 62} 63 64// The Alexa for Business metadata associated with an Amazon Chime user, used to 65// integrate Alexa for Business with a device. 66type AlexaForBusinessMetadata struct { 67 68 // The ARN of the room resource. 69 AlexaForBusinessRoomArn *string 70 71 // Starts or stops Alexa for Business. 72 IsAlexaForBusinessEnabled *bool 73} 74 75// The details of an AppInstance, an instance of an Amazon Chime SDK messaging 76// application. 77type AppInstance struct { 78 79 // The ARN of the messaging instance. 80 AppInstanceArn *string 81 82 // The time at which an AppInstance was created. In epoch milliseconds. 83 CreatedTimestamp *time.Time 84 85 // The time an AppInstance was last updated. In epoch milliseconds. 86 LastUpdatedTimestamp *time.Time 87 88 // The metadata of an AppInstance. 89 Metadata *string 90 91 // The name of an AppInstance. 92 Name *string 93} 94 95// The details of an AppInstanceAdmin. 96type AppInstanceAdmin struct { 97 98 // The AppInstanceAdmin data. 99 Admin *Identity 100 101 // The ARN of the AppInstance for which the user is an administrator. 102 AppInstanceArn *string 103 104 // The time at which an administrator was created. 105 CreatedTimestamp *time.Time 106} 107 108// Summary of the details of an AppInstanceAdmin. 109type AppInstanceAdminSummary struct { 110 111 // The details of the AppInstanceAdmin. 112 Admin *Identity 113} 114 115// The details of the data-retention settings for an AppInstance. 116type AppInstanceRetentionSettings struct { 117 118 // The length of time in days to retain the messages in a channel. 119 ChannelRetentionSettings *ChannelRetentionSettings 120} 121 122// The details of the streaming configuration of an AppInstance. 123type AppInstanceStreamingConfiguration struct { 124 125 // The type of data to be streamed. 126 // 127 // This member is required. 128 AppInstanceDataType AppInstanceDataType 129 130 // The resource ARN. 131 // 132 // This member is required. 133 ResourceArn *string 134} 135 136// Summary of the data for an AppInstance. 137type AppInstanceSummary struct { 138 139 // The AppInstance ARN. 140 AppInstanceArn *string 141 142 // The metadata of the AppInstance. 143 Metadata *string 144 145 // The name of the AppInstance. 146 Name *string 147} 148 149// The details of an AppInstanceUser. 150type AppInstanceUser struct { 151 152 // The ARN of the AppInstanceUser. 153 AppInstanceUserArn *string 154 155 // The time at which the AppInstanceUser was created. 156 CreatedTimestamp *time.Time 157 158 // The time at which the AppInstanceUser was last updated. 159 LastUpdatedTimestamp *time.Time 160 161 // The metadata of the AppInstanceUser. 162 Metadata *string 163 164 // The name of the AppInstanceUser. 165 Name *string 166} 167 168// Summary of the membership details of an AppInstanceUser. 169type AppInstanceUserMembershipSummary struct { 170 171 // The time at which a message was last read. 172 ReadMarkerTimestamp *time.Time 173 174 // The type of ChannelMembership. 175 Type ChannelMembershipType 176} 177 178// Summary of the details of an AppInstanceUser. 179type AppInstanceUserSummary struct { 180 181 // The ARN of the AppInstanceUser. 182 AppInstanceUserArn *string 183 184 // The metadata of the AppInstanceUser. 185 Metadata *string 186 187 // The name of an AppInstanceUser. 188 Name *string 189} 190 191// An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken 192// . The JoinToken allows a client to authenticate and join as the specified 193// attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is 194// called. After that, the attendee is unable to join the meeting. We recommend 195// securely transferring each JoinToken from your server application to the client 196// so that no other client has access to the token except for the one authorized to 197// represent the attendee. 198type Attendee struct { 199 200 // The Amazon Chime SDK attendee ID. 201 AttendeeId *string 202 203 // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee 204 // to an identity managed by a builder application. 205 ExternalUserId *string 206 207 // The join token used by the Amazon Chime SDK attendee. 208 JoinToken *string 209} 210 211// A resource that allows Enterprise account administrators to configure an 212// interface to receive events from Amazon Chime. 213type Bot struct { 214 215 // The bot email address. 216 BotEmail *string 217 218 // The bot ID. 219 BotId *string 220 221 // The bot type. 222 BotType BotType 223 224 // The bot creation timestamp, in ISO 8601 format. 225 CreatedTimestamp *time.Time 226 227 // When true, the bot is stopped from running in your account. 228 Disabled *bool 229 230 // The bot display name. 231 DisplayName *string 232 233 // The security token used to authenticate Amazon Chime with the outgoing event 234 // endpoint. 235 SecurityToken *string 236 237 // The updated bot timestamp, in ISO 8601 format. 238 UpdatedTimestamp *time.Time 239 240 // The unique ID for the bot user. 241 UserId *string 242} 243 244// The Amazon Chime Business Calling settings for the administrator's AWS account. 245// Includes any Amazon S3 buckets designated for storing call detail records. 246type BusinessCallingSettings struct { 247 248 // The Amazon S3 bucket designated for call detail record storage. 249 CdrBucket *string 250} 251 252// The details of a channel. 253type Channel struct { 254 255 // The ARN of the channel. 256 ChannelArn *string 257 258 // The AppInstanceUser who created the channel. 259 CreatedBy *Identity 260 261 // The time at which the AppInstanceUser created the channel. 262 CreatedTimestamp *time.Time 263 264 // The time at which a member sent the last message in the channel. 265 LastMessageTimestamp *time.Time 266 267 // The time at which a channel was last updated. 268 LastUpdatedTimestamp *time.Time 269 270 // The channel's metadata. 271 Metadata *string 272 273 // The mode of the channel. 274 Mode ChannelMode 275 276 // The name of the channel. 277 Name *string 278 279 // The channel's privacy setting. 280 Privacy ChannelPrivacy 281} 282 283// The details of a channel ban. 284type ChannelBan struct { 285 286 // The ARN of the channel from which a member is being banned. 287 ChannelArn *string 288 289 // The AppInstanceUser who created the ban. 290 CreatedBy *Identity 291 292 // The time at which the ban was created. 293 CreatedTimestamp *time.Time 294 295 // The member being banned from the channel. 296 Member *Identity 297} 298 299// Summary of the details of a ChannelBan. 300type ChannelBanSummary struct { 301 302 // The member being banned from a channel. 303 Member *Identity 304} 305 306// The details of a channel member. 307type ChannelMembership struct { 308 309 // The ARN of the member's channel. 310 ChannelArn *string 311 312 // The time at which the channel membership was created. 313 CreatedTimestamp *time.Time 314 315 // The identifier of the member who invited another member. 316 InvitedBy *Identity 317 318 // The time at which a channel membership was last updated. 319 LastUpdatedTimestamp *time.Time 320 321 // The data of the channel member. 322 Member *Identity 323 324 // The membership type set for the channel member. 325 Type ChannelMembershipType 326} 327 328// Summary of the channel membership details of an AppInstanceUser. 329type ChannelMembershipForAppInstanceUserSummary struct { 330 331 // Returns the channel membership data for an AppInstance. 332 AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary 333 334 // Summary of the details of a Channel. 335 ChannelSummary *ChannelSummary 336} 337 338// Summary of the details of a ChannelMembership. 339type ChannelMembershipSummary struct { 340 341 // A member's summary data. 342 Member *Identity 343} 344 345// The details of a message in a channel. 346type ChannelMessage struct { 347 348 // The ARN of the channel. 349 ChannelArn *string 350 351 // The message content. 352 Content *string 353 354 // The time at which the message was created. 355 CreatedTimestamp *time.Time 356 357 // The time at which a message was edited. 358 LastEditedTimestamp *time.Time 359 360 // The time at which a message was updated. 361 LastUpdatedTimestamp *time.Time 362 363 // The ID of a message. 364 MessageId *string 365 366 // The message metadata. 367 Metadata *string 368 369 // The persistence setting for a channel message. 370 Persistence ChannelMessagePersistenceType 371 372 // Hides the content of a message. 373 Redacted bool 374 375 // The message sender. 376 Sender *Identity 377 378 // The message type. 379 Type ChannelMessageType 380} 381 382// Summary of the messages in a Channel. 383type ChannelMessageSummary struct { 384 385 // The content of the message. 386 Content *string 387 388 // The time at which the message summary was created. 389 CreatedTimestamp *time.Time 390 391 // The time at which a message was last edited. 392 LastEditedTimestamp *time.Time 393 394 // The time at which a message was last updated. 395 LastUpdatedTimestamp *time.Time 396 397 // The ID of the message. 398 MessageId *string 399 400 // The metadata of the message. 401 Metadata *string 402 403 // Indicates whether a message was redacted. 404 Redacted bool 405 406 // The message sender. 407 Sender *Identity 408 409 // The type of message. 410 Type ChannelMessageType 411} 412 413// Summary of the details of a moderated channel. 414type ChannelModeratedByAppInstanceUserSummary struct { 415 416 // Summary of the details of a Channel. 417 ChannelSummary *ChannelSummary 418} 419 420// The details of a channel moderator. 421type ChannelModerator struct { 422 423 // The ARN of the moderator's channel. 424 ChannelArn *string 425 426 // The AppInstanceUser who created the moderator. 427 CreatedBy *Identity 428 429 // The time at which the moderator was created. 430 CreatedTimestamp *time.Time 431 432 // The moderator's data. 433 Moderator *Identity 434} 435 436// Summary of the details of a ChannelModerator. 437type ChannelModeratorSummary struct { 438 439 // The data for a moderator. 440 Moderator *Identity 441} 442 443// The details of the retention settings for a channel. 444type ChannelRetentionSettings struct { 445 446 // The time in days to retain the messages in a channel. 447 RetentionDays *int32 448} 449 450// Summary of the details of a Channel. 451type ChannelSummary struct { 452 453 // The ARN of the channel. 454 ChannelArn *string 455 456 // The time at which the last message in a channel was sent. 457 LastMessageTimestamp *time.Time 458 459 // The metadata of the channel. 460 Metadata *string 461 462 // The mode of the channel. 463 Mode ChannelMode 464 465 // The name of the channel. 466 Name *string 467 468 // The privacy setting of the channel. 469 Privacy ChannelPrivacy 470} 471 472// The retention settings that determine how long to retain conversation messages 473// for an Amazon Chime Enterprise account. 474type ConversationRetentionSettings struct { 475 476 // The number of days for which to retain conversation messages. 477 RetentionDays *int32 478} 479 480// The list of errors returned when errors are encountered during the 481// BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, 482// error codes, and error messages. 483type CreateAttendeeError struct { 484 485 // The error code. 486 ErrorCode *string 487 488 // The error message. 489 ErrorMessage *string 490 491 // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee 492 // to an identity managed by a builder application. 493 ExternalUserId *string 494} 495 496// The Amazon Chime SDK attendee fields to create, used with the 497// BatchCreateAttendee action. 498type CreateAttendeeRequestItem struct { 499 500 // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee 501 // to an identity managed by a builder application. 502 // 503 // This member is required. 504 ExternalUserId *string 505 506 // The tag key-value pairs. 507 Tags []Tag 508} 509 510// The SIP credentials used to authenticate requests to your Amazon Chime Voice 511// Connector. 512type Credential struct { 513 514 // The RFC2617 compliant password associated with the SIP credentials, in US-ASCII 515 // format. 516 Password *string 517 518 // The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII 519 // format. 520 Username *string 521} 522 523// The Dialed Number Identification Service (DNIS) emergency calling configuration 524// details associated with an Amazon Chime Voice Connector's emergency calling 525// configuration. 526type DNISEmergencyCallingConfiguration struct { 527 528 // The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 529 // format. 530 // 531 // This member is required. 532 CallingCountry *string 533 534 // The DNIS phone number to route emergency calls to, in E.164 format. 535 // 536 // This member is required. 537 EmergencyPhoneNumber *string 538 539 // The DNIS phone number to route test emergency calls to, in E.164 format. 540 TestPhoneNumber *string 541} 542 543// The emergency calling configuration details associated with an Amazon Chime 544// Voice Connector. 545type EmergencyCallingConfiguration struct { 546 547 // The Dialed Number Identification Service (DNIS) emergency calling configuration 548 // details. 549 DNIS []DNISEmergencyCallingConfiguration 550} 551 552// The configuration that allows a bot to receive outgoing events. Can be either an 553// HTTPS endpoint or a Lambda function ARN. 554type EventsConfiguration struct { 555 556 // The bot ID. 557 BotId *string 558 559 // Lambda function ARN that allows a bot to receive outgoing events. 560 LambdaFunctionArn *string 561 562 // HTTPS endpoint that allows a bot to receive outgoing events. 563 OutboundEventsHTTPSEndpoint *string 564} 565 566// The country and area code for a proxy phone number in a proxy phone session. 567type GeoMatchParams struct { 568 569 // The area code. 570 // 571 // This member is required. 572 AreaCode *string 573 574 // The country. 575 // 576 // This member is required. 577 Country *string 578} 579 580// The details of a user. 581type Identity struct { 582 583 // The ARN in an Identity. 584 Arn *string 585 586 // The name in an Identity. 587 Name *string 588} 589 590// Invitation object returned after emailing users to invite them to join the 591// Amazon Chime Team account. 592type Invite struct { 593 594 // The email address to which the invite is sent. 595 EmailAddress *string 596 597 // The status of the invite email. 598 EmailStatus EmailStatus 599 600 // The invite ID. 601 InviteId *string 602 603 // The status of the invite. 604 Status InviteStatus 605} 606 607// The logging configuration associated with an Amazon Chime Voice Connector. 608// Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch 609// Logs. 610type LoggingConfiguration struct { 611 612 // When true, enables SIP message logs for sending to Amazon CloudWatch Logs. 613 EnableSIPLogs *bool 614} 615 616// A set of endpoints used by clients to connect to the media service group for a 617// Amazon Chime SDK meeting. 618type MediaPlacement struct { 619 620 // The audio fallback URL. 621 AudioFallbackUrl *string 622 623 // The audio host URL. 624 AudioHostUrl *string 625 626 // The screen data URL. 627 ScreenDataUrl *string 628 629 // The screen sharing URL. 630 ScreenSharingUrl *string 631 632 // The screen viewing URL. 633 ScreenViewingUrl *string 634 635 // The signaling URL. 636 SignalingUrl *string 637 638 // The turn control URL. 639 TurnControlUrl *string 640} 641 642// A meeting created using the Amazon Chime SDK. 643type Meeting struct { 644 645 // The external meeting ID. 646 ExternalMeetingId *string 647 648 // The media placement for the meeting. 649 MediaPlacement *MediaPlacement 650 651 // The Region in which you create the meeting. Available values: af-south-1 , 652 // ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , 653 // ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , 654 // eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 . 655 MediaRegion *string 656 657 // The Amazon Chime SDK meeting ID. 658 MeetingId *string 659} 660 661// The resource target configurations for receiving Amazon Chime SDK meeting and 662// attendee event notifications. The Amazon Chime SDK supports resource targets 663// located in the US East (N. Virginia) AWS Region (us-east-1). 664type MeetingNotificationConfiguration struct { 665 666 // The SNS topic ARN. 667 SnsTopicArn *string 668 669 // The SQS queue ARN. 670 SqsQueueArn *string 671} 672 673// The member details, such as email address, name, member ID, and member type. 674type Member struct { 675 676 // The Amazon Chime account ID. 677 AccountId *string 678 679 // The member email address. 680 Email *string 681 682 // The member name. 683 FullName *string 684 685 // The member ID (user ID or bot ID). 686 MemberId *string 687 688 // The member type. 689 MemberType MemberType 690} 691 692// The list of errors returned when a member action results in an error. 693type MemberError struct { 694 695 // The error code. 696 ErrorCode ErrorCode 697 698 // The error message. 699 ErrorMessage *string 700 701 // The member ID. 702 MemberId *string 703} 704 705// Membership details, such as member ID and member role. 706type MembershipItem struct { 707 708 // The member ID. 709 MemberId *string 710 711 // The member role. 712 Role RoomMembershipRole 713} 714 715// The websocket endpoint used to connect to Amazon Chime SDK messaging. 716type MessagingSessionEndpoint struct { 717 718 // The endpoint to which you establish a websocket connection. 719 Url *string 720} 721 722// A phone number for which an order has been placed. 723type OrderedPhoneNumber struct { 724 725 // The phone number, in E.164 format. 726 E164PhoneNumber *string 727 728 // The phone number status. 729 Status OrderedPhoneNumberStatus 730} 731 732// Origination settings enable your SIP hosts to receive inbound calls using your 733// Amazon Chime Voice Connector. 734type Origination struct { 735 736 // When origination settings are disabled, inbound calls are not enabled for your 737 // Amazon Chime Voice Connector. 738 Disabled *bool 739 740 // The call distribution properties defined for your SIP hosts. Valid range: 741 // Minimum value of 1. Maximum value of 20. 742 Routes []OriginationRoute 743} 744 745// Origination routes define call distribution properties for your SIP hosts to 746// receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten 747// origination routes for each Amazon Chime Voice Connector. 748type OriginationRoute struct { 749 750 // The FQDN or IP address to contact for origination traffic. 751 Host *string 752 753 // The designated origination route port. Defaults to 5060. 754 Port *int32 755 756 // The priority associated with the host, with 1 being the highest priority. Higher 757 // priority hosts are attempted first. 758 Priority *int32 759 760 // The protocol to use for the origination route. Encryption-enabled Amazon Chime 761 // Voice Connectors use TCP protocol by default. 762 Protocol OriginationRouteProtocol 763 764 // The weight associated with the host. If hosts are equal in priority, calls are 765 // redistributed among them based on their relative weight. 766 Weight *int32 767} 768 769// The phone number and proxy phone number for a participant in an Amazon Chime 770// Voice Connector proxy session. 771type Participant struct { 772 773 // The participant's phone number. 774 PhoneNumber *string 775 776 // The participant's proxy phone number. 777 ProxyPhoneNumber *string 778} 779 780// A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice 781// Connector. 782type PhoneNumber struct { 783 784 // The phone number associations. 785 Associations []PhoneNumberAssociation 786 787 // The outbound calling name associated with the phone number. 788 CallingName *string 789 790 // The outbound calling name status. 791 CallingNameStatus CallingNameStatus 792 793 // The phone number capabilities. 794 Capabilities *PhoneNumberCapabilities 795 796 // The phone number creation timestamp, in ISO 8601 format. 797 CreatedTimestamp *time.Time 798 799 // The deleted phone number timestamp, in ISO 8601 format. 800 DeletionTimestamp *time.Time 801 802 // The phone number, in E.164 format. 803 E164PhoneNumber *string 804 805 // The phone number ID. 806 PhoneNumberId *string 807 808 // The phone number product type. 809 ProductType PhoneNumberProductType 810 811 // The phone number status. 812 Status PhoneNumberStatus 813 814 // The phone number type. 815 Type PhoneNumberType 816 817 // The updated phone number timestamp, in ISO 8601 format. 818 UpdatedTimestamp *time.Time 819} 820 821// The phone number associations, such as Amazon Chime account ID, Amazon Chime 822// user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group 823// ID. 824type PhoneNumberAssociation struct { 825 826 // The timestamp of the phone number association, in ISO 8601 format. 827 AssociatedTimestamp *time.Time 828 829 // Defines the association with an Amazon Chime account ID, user ID, Amazon Chime 830 // Voice Connector ID, or Amazon Chime Voice Connector group ID. 831 Name PhoneNumberAssociationName 832 833 // Contains the ID for the entity specified in Name. 834 Value *string 835} 836 837// The phone number capabilities for Amazon Chime Business Calling phone numbers, 838// such as enabled inbound and outbound calling and text messaging. 839type PhoneNumberCapabilities struct { 840 841 // Allows or denies inbound calling for the specified phone number. 842 InboundCall *bool 843 844 // Allows or denies inbound MMS messaging for the specified phone number. 845 InboundMMS *bool 846 847 // Allows or denies inbound SMS messaging for the specified phone number. 848 InboundSMS *bool 849 850 // Allows or denies outbound calling for the specified phone number. 851 OutboundCall *bool 852 853 // Allows or denies outbound MMS messaging for the specified phone number. 854 OutboundMMS *bool 855 856 // Allows or denies outbound SMS messaging for the specified phone number. 857 OutboundSMS *bool 858} 859 860// If the phone number action fails for one or more of the phone numbers in the 861// request, a list of the phone numbers is returned, along with error codes and 862// error messages. 863type PhoneNumberError struct { 864 865 // The error code. 866 ErrorCode ErrorCode 867 868 // The error message. 869 ErrorMessage *string 870 871 // The phone number ID for which the action failed. 872 PhoneNumberId *string 873} 874 875// The details of a phone number order created for Amazon Chime. 876type PhoneNumberOrder struct { 877 878 // The phone number order creation time stamp, in ISO 8601 format. 879 CreatedTimestamp *time.Time 880 881 // The ordered phone number details, such as the phone number in E.164 format and 882 // the phone number status. 883 OrderedPhoneNumbers []OrderedPhoneNumber 884 885 // The phone number order ID. 886 PhoneNumberOrderId *string 887 888 // The phone number order product type. 889 ProductType PhoneNumberProductType 890 891 // The status of the phone number order. 892 Status PhoneNumberOrderStatus 893 894 // The updated phone number order time stamp, in ISO 8601 format. 895 UpdatedTimestamp *time.Time 896} 897 898// The proxy configuration for an Amazon Chime Voice Connector. 899type Proxy struct { 900 901 // The default number of minutes allowed for proxy sessions. 902 DefaultSessionExpiryMinutes *int32 903 904 // When true, stops proxy sessions from being created on the specified Amazon Chime 905 // Voice Connector. 906 Disabled *bool 907 908 // The phone number to route calls to after a proxy session expires. 909 FallBackPhoneNumber *string 910 911 // The countries for proxy phone numbers to be selected from. 912 PhoneNumberCountries []string 913} 914 915// The proxy session for an Amazon Chime Voice Connector. 916type ProxySession struct { 917 918 // The proxy session capabilities. 919 Capabilities []Capability 920 921 // The created time stamp, in ISO 8601 format. 922 CreatedTimestamp *time.Time 923 924 // The ended time stamp, in ISO 8601 format. 925 EndedTimestamp *time.Time 926 927 // The number of minutes allowed for the proxy session. 928 ExpiryMinutes *int32 929 930 // The preference for matching the country or area code of the proxy phone number 931 // with that of the first participant. 932 GeoMatchLevel GeoMatchLevel 933 934 // The country and area code for the proxy phone number. 935 GeoMatchParams *GeoMatchParams 936 937 // The name of the proxy session. 938 Name *string 939 940 // The preference for proxy phone number reuse, or stickiness, between the same 941 // participants across sessions. 942 NumberSelectionBehavior NumberSelectionBehavior 943 944 // The proxy session participants. 945 Participants []Participant 946 947 // The proxy session ID. 948 ProxySessionId *string 949 950 // The status of the proxy session. 951 Status ProxySessionStatus 952 953 // The updated time stamp, in ISO 8601 format. 954 UpdatedTimestamp *time.Time 955 956 // The Amazon Chime voice connector ID. 957 VoiceConnectorId *string 958} 959 960// The retention settings for an Amazon Chime Enterprise account that determine how 961// long to retain items such as chat-room messages and chat-conversation messages. 962type RetentionSettings struct { 963 964 // The chat conversation retention settings. 965 ConversationRetentionSettings *ConversationRetentionSettings 966 967 // The chat room retention settings. 968 RoomRetentionSettings *RoomRetentionSettings 969} 970 971// The Amazon Chime chat room details. 972type Room struct { 973 974 // The Amazon Chime account ID. 975 AccountId *string 976 977 // The identifier of the room creator. 978 CreatedBy *string 979 980 // The room creation timestamp, in ISO 8601 format. 981 CreatedTimestamp *time.Time 982 983 // The room name. 984 Name *string 985 986 // The room ID. 987 RoomId *string 988 989 // The room update timestamp, in ISO 8601 format. 990 UpdatedTimestamp *time.Time 991} 992 993// The room membership details. 994type RoomMembership struct { 995 996 // The identifier of the user that invited the room member. 997 InvitedBy *string 998 999 // The member details, such as email address, name, member ID, and member type. 1000 Member *Member 1001 1002 // The membership role. 1003 Role RoomMembershipRole 1004 1005 // The room ID. 1006 RoomId *string 1007 1008 // The room membership update timestamp, in ISO 8601 format. 1009 UpdatedTimestamp *time.Time 1010} 1011 1012// The retention settings that determine how long to retain chat-room messages for 1013// an Amazon Chime Enterprise account. 1014type RoomRetentionSettings struct { 1015 1016 // The number of days for which to retain chat-room messages. 1017 RetentionDays *int32 1018} 1019 1020// An Active Directory (AD) group whose members are granted permission to act as 1021// delegates. 1022type SigninDelegateGroup struct { 1023 1024 // The group name. 1025 GroupName *string 1026} 1027 1028// The details of the SIP media application, including name and endpoints. An AWS 1029// account can have multiple SIP media applications. 1030type SipMediaApplication struct { 1031 1032 // The AWS Region in which the SIP media application is created. 1033 AwsRegion *string 1034 1035 // The SIP media application creation timestamp, in ISO 8601 format. 1036 CreatedTimestamp *time.Time 1037 1038 // List of endpoints for SIP media application. Currently, only one endpoint per 1039 // SIP media application is permitted. 1040 Endpoints []SipMediaApplicationEndpoint 1041 1042 // The name of the SIP media application. 1043 Name *string 1044 1045 // The SIP media application ID. 1046 SipMediaApplicationId *string 1047 1048 // The SIP media application updated timestamp, in ISO 8601 format. 1049 UpdatedTimestamp *time.Time 1050} 1051 1052// A Call instance for a SIP media application. 1053type SipMediaApplicationCall struct { 1054 1055 // The transaction ID of a call. 1056 TransactionId *string 1057} 1058 1059// The endpoint assigned to the SIP media application. 1060type SipMediaApplicationEndpoint struct { 1061 1062 // Valid Amazon Resource Name (ARN) of the Lambda function. The function must be 1063 // created in the same AWS Region as the SIP media application. 1064 LambdaArn *string 1065} 1066 1067// Logging configuration of the SIP media application. 1068type SipMediaApplicationLoggingConfiguration struct { 1069 1070 // Enables application message logs for the SIP media application. 1071 EnableSipMediaApplicationMessageLogs *bool 1072} 1073 1074// The SIP rule details, including name, triggers, and target applications. An AWS 1075// account can have multiple SIP rules. 1076type SipRule struct { 1077 1078 // The time at which the SIP rule was created, in ISO 8601 format. 1079 CreatedTimestamp *time.Time 1080 1081 // Indicates whether the SIP rule is enabled or disabled. You must disable a rule 1082 // before you can delete it. 1083 Disabled *bool 1084 1085 // The name of the SIP rule. 1086 Name *string 1087 1088 // The SIP rule ID. 1089 SipRuleId *string 1090 1091 // Target SIP media application and other details, such as priority and AWS Region, 1092 // to be specified in the SIP rule. Only one SIP rule per AWS Region can be 1093 // provided. 1094 TargetApplications []SipRuleTargetApplication 1095 1096 // The type of trigger assigned to the SIP rule in TriggerValue, currently 1097 // RequestUriHostname or ToPhoneNumber. 1098 TriggerType SipRuleTriggerType 1099 1100 // If TriggerType is RequestUriHostname, then the value can be the outbound host 1101 // name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then 1102 // the value can be a customer-owned phone number in E164 format. SipRule is 1103 // triggered when a SIP rule requests host name or ToPhoneNumber matches in the 1104 // incoming SIP request. 1105 TriggerValue *string 1106 1107 // The time at which the SIP rule was last updated, in ISO 8601 format. 1108 UpdatedTimestamp *time.Time 1109} 1110 1111// Target SIP media application and other details, such as priority and AWS Region, 1112// to be specified in the SIP rule. Only one SIP rule per AWS Region can be 1113// provided. 1114type SipRuleTargetApplication struct { 1115 1116 // The AWS Region of the target application. 1117 AwsRegion *string 1118 1119 // Priority of the SIP media application in the target list. 1120 Priority *int32 1121 1122 // The SIP media application ID. 1123 SipMediaApplicationId *string 1124} 1125 1126// The streaming configuration associated with an Amazon Chime Voice Connector. 1127// Specifies whether media streaming is enabled for sending to Amazon Kinesis, and 1128// shows the retention period for the Amazon Kinesis data, in hours. 1129type StreamingConfiguration struct { 1130 1131 // The retention period, in hours, for the Amazon Kinesis data. 1132 // 1133 // This member is required. 1134 DataRetentionInHours *int32 1135 1136 // When true, media streaming to Amazon Kinesis is turned off. 1137 Disabled *bool 1138 1139 // The streaming notification targets. 1140 StreamingNotificationTargets []StreamingNotificationTarget 1141} 1142 1143// The targeted recipient for a streaming configuration notification. 1144type StreamingNotificationTarget struct { 1145 1146 // The streaming notification target. 1147 // 1148 // This member is required. 1149 NotificationTarget NotificationTarget 1150} 1151 1152// Describes a tag applied to a resource. 1153type Tag struct { 1154 1155 // The key of the tag. 1156 // 1157 // This member is required. 1158 Key *string 1159 1160 // The value of the tag. 1161 // 1162 // This member is required. 1163 Value *string 1164} 1165 1166// Settings that allow management of telephony permissions for an Amazon Chime 1167// user, such as inbound and outbound calling and text messaging. 1168type TelephonySettings struct { 1169 1170 // Allows or denies inbound calling. 1171 // 1172 // This member is required. 1173 InboundCalling *bool 1174 1175 // Allows or denies outbound calling. 1176 // 1177 // This member is required. 1178 OutboundCalling *bool 1179 1180 // Allows or denies SMS messaging. 1181 // 1182 // This member is required. 1183 SMS *bool 1184} 1185 1186// Termination settings enable your SIP hosts to make outbound calls using your 1187// Amazon Chime Voice Connector. 1188type Termination struct { 1189 1190 // The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. 1191 // Required. 1192 CallingRegions []string 1193 1194 // The IP addresses allowed to make calls, in CIDR format. Required. 1195 CidrAllowedList []string 1196 1197 // The limit on calls per second. Max value based on account service quota. Default 1198 // value of 1. 1199 CpsLimit *int32 1200 1201 // The default caller ID phone number. 1202 DefaultPhoneNumber *string 1203 1204 // When termination settings are disabled, outbound calls can not be made. 1205 Disabled *bool 1206} 1207 1208// The termination health details, including the source IP address and timestamp of 1209// the last successful SIP OPTIONS message from your SIP infrastructure. 1210type TerminationHealth struct { 1211 1212 // The source IP address. 1213 Source *string 1214 1215 // The timestamp, in ISO 8601 format. 1216 Timestamp *time.Time 1217} 1218 1219// The phone number ID, product type, or calling name fields to update, used with 1220// the BatchUpdatePhoneNumber and UpdatePhoneNumber actions. 1221type UpdatePhoneNumberRequestItem struct { 1222 1223 // The phone number ID to update. 1224 // 1225 // This member is required. 1226 PhoneNumberId *string 1227 1228 // The outbound calling name to update. 1229 CallingName *string 1230 1231 // The product type to update. 1232 ProductType PhoneNumberProductType 1233} 1234 1235// The user ID and user fields to update, used with the BatchUpdateUser action. 1236type UpdateUserRequestItem struct { 1237 1238 // The user ID. 1239 // 1240 // This member is required. 1241 UserId *string 1242 1243 // The Alexa for Business metadata. 1244 AlexaForBusinessMetadata *AlexaForBusinessMetadata 1245 1246 // The user license type. 1247 LicenseType License 1248 1249 // The user type. 1250 UserType UserType 1251} 1252 1253// The user on the Amazon Chime account. 1254type User struct { 1255 1256 // The user ID. 1257 // 1258 // This member is required. 1259 UserId *string 1260 1261 // The Amazon Chime account ID. 1262 AccountId *string 1263 1264 // The Alexa for Business metadata. 1265 AlexaForBusinessMetadata *AlexaForBusinessMetadata 1266 1267 // The display name of the user. 1268 DisplayName *string 1269 1270 // Date and time when the user is invited to the Amazon Chime account, in ISO 8601 1271 // format. 1272 InvitedOn *time.Time 1273 1274 // The license type for the user. 1275 LicenseType License 1276 1277 // The user's personal meeting PIN. 1278 PersonalPIN *string 1279 1280 // The primary email address of the user. 1281 PrimaryEmail *string 1282 1283 // The primary phone number associated with the user. 1284 PrimaryProvisionedNumber *string 1285 1286 // Date and time when the user is registered, in ISO 8601 format. 1287 RegisteredOn *time.Time 1288 1289 // The user invite status. 1290 UserInvitationStatus InviteStatus 1291 1292 // The user registration status. 1293 UserRegistrationStatus RegistrationStatus 1294 1295 // The user type. 1296 UserType UserType 1297} 1298 1299// The list of errors returned when errors are encountered during the 1300// BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes 1301// user IDs, error codes, and error messages. 1302type UserError struct { 1303 1304 // The error code. 1305 ErrorCode ErrorCode 1306 1307 // The error message. 1308 ErrorMessage *string 1309 1310 // The user ID for which the action failed. 1311 UserId *string 1312} 1313 1314// Settings associated with an Amazon Chime user, including inbound and outbound 1315// calling and text messaging. 1316type UserSettings struct { 1317 1318 // The telephony settings associated with the user. 1319 // 1320 // This member is required. 1321 Telephony *TelephonySettings 1322} 1323 1324// The Amazon Chime Voice Connector configuration, including outbound host name and 1325// encryption settings. 1326type VoiceConnector struct { 1327 1328 // The AWS Region in which the Amazon Chime Voice Connector is created. Default: 1329 // us-east-1. 1330 AwsRegion VoiceConnectorAwsRegion 1331 1332 // The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format. 1333 CreatedTimestamp *time.Time 1334 1335 // The name of the Amazon Chime Voice Connector. 1336 Name *string 1337 1338 // The outbound host name for the Amazon Chime Voice Connector. 1339 OutboundHostName *string 1340 1341 // Designates whether encryption is required for the Amazon Chime Voice Connector. 1342 RequireEncryption *bool 1343 1344 // The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format. 1345 UpdatedTimestamp *time.Time 1346 1347 // The Amazon Chime Voice Connector ID. 1348 VoiceConnectorId *string 1349} 1350 1351// The Amazon Chime Voice Connector group configuration, including associated 1352// Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors 1353// from different AWS Regions in your group. This creates a fault tolerant 1354// mechanism for fallback in case of availability events. 1355type VoiceConnectorGroup struct { 1356 1357 // The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format. 1358 CreatedTimestamp *time.Time 1359 1360 // The name of the Amazon Chime Voice Connector group. 1361 Name *string 1362 1363 // The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format. 1364 UpdatedTimestamp *time.Time 1365 1366 // The Amazon Chime Voice Connector group ID. 1367 VoiceConnectorGroupId *string 1368 1369 // The Amazon Chime Voice Connectors to which to route inbound calls. 1370 VoiceConnectorItems []VoiceConnectorItem 1371} 1372 1373// For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to 1374// which to route inbound calls. Includes priority configuration settings. Limit: 3 1375// VoiceConnectorItems per Amazon Chime Voice Connector group. 1376type VoiceConnectorItem struct { 1377 1378 // The priority associated with the Amazon Chime Voice Connector, with 1 being the 1379 // highest priority. Higher priority Amazon Chime Voice Connectors are attempted 1380 // first. 1381 // 1382 // This member is required. 1383 Priority *int32 1384 1385 // The Amazon Chime Voice Connector ID. 1386 // 1387 // This member is required. 1388 VoiceConnectorId *string 1389} 1390 1391// The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets 1392// designated for storing call detail records. 1393type VoiceConnectorSettings struct { 1394 1395 // The Amazon S3 bucket designated for call detail record storage. 1396 CdrBucket *string 1397} 1398