create_meeting_with_attendees
async
¶
create_meeting_with_attendees(
client_request_token: ClientRequestToken,
media_region: MediaRegion,
external_meeting_id: ExternalMeetingId,
attendees: CreateMeetingWithAttendeesRequestItemList,
*,
config_overrides: Optional[AsyncChimeSDKMeetingsClientConfig] = None,
meeting_host_id: Optional[ExternalUserId] = None,
meeting_features: Optional[MeetingFeaturesConfiguration] = None,
notifications_configuration: Optional[NotificationsConfiguration] = None,
primary_meeting_id: Optional[PrimaryMeetingId] = None,
tenant_ids: Optional[TenantIdList] = None,
tags: Optional[TagList] = None,
media_placement_network_type: Optional[MediaPlacementNetworkType] = None,
) -> CreateMeetingWithAttendeesResponse
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Available Regions and Using meeting Regions, both in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
If you use this API in conjuction with the and APIs, and you don't specify the MeetingFeatures.Content.MaxResolution or MeetingFeatures.Video.MaxResolution parameters, the following defaults are used:
-
Content.MaxResolution: FHD
-
Video.MaxResolution: HD
Parameters:
-
client_request_token(ClientRequestToken) –The unique identifier for the client request. Use a different token for different meetings.
-
media_region(MediaRegion) –The Region in which to create the meeting.
Available values:
af-south-1,ap-northeast-1,ap-northeast-2,ap-south-1,ap-southeast-1,ap-southeast-2,ca-central-1,eu-central-1,eu-north-1,eu-south-1,eu-west-1,eu-west-2,eu-west-3,sa-east-1,us-east-1,us-east-2,us-west-1,us-west-2.Available values in Amazon Web Services GovCloud (US) Regions:
us-gov-east-1,us-gov-west-1. -
meeting_host_id(Optional[ExternalUserId], default:None) –Reserved.
-
external_meeting_id(ExternalMeetingId) –The external meeting ID.
Pattern:
[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*Values that begin with
aws:are reserved. You can't configure a value that uses this prefix. Case insensitive. -
meeting_features(Optional[MeetingFeaturesConfiguration], default:None) –Lists the audio and video features enabled for a meeting, such as echo reduction.
-
notifications_configuration(Optional[NotificationsConfiguration], default:None) –The configuration for resource targets to receive notifications when meeting and attendee events occur.
-
attendees(CreateMeetingWithAttendeesRequestItemList) –The attendee information, including attendees' IDs and join tokens.
-
primary_meeting_id(Optional[PrimaryMeetingId], default:None) –When specified, replicates the media from the primary meeting to the new meeting.
-
tenant_ids(Optional[TenantIdList], default:None) –A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
-
tags(Optional[TagList], default:None) –The tags in the request.
-
media_placement_network_type(Optional[MediaPlacementNetworkType], default:None) –The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).
Raises:
-
BadRequestException–The input parameters don't match the service's restrictions.
-
ConflictException–Multiple instances of the same request have been made simultaneously.
-
ForbiddenException–The client is permanently forbidden from making the request.
-
LimitExceededException–The request exceeds the resource limit.
-
ServiceFailureException–The service encountered an unexpected error.
-
ServiceUnavailableException–The service is currently unavailable.
-
ThrottlingException–The number of customer requests exceeds the request rate limit.
-
UnauthorizedException–The user isn't authorized to request a resource.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_chime_sdk_meetings/_services/async_chime_sdk_meetings.py
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | |