create_meeting
async
¶
create_meeting(
client_request_token: ClientRequestToken,
media_region: MediaRegion,
external_meeting_id: ExternalMeetingId,
*,
config_overrides: Optional[AsyncChimeSDKMeetingsClientConfig] = None,
meeting_host_id: Optional[ExternalUserId] = None,
notifications_configuration: Optional[NotificationsConfiguration] = None,
meeting_features: Optional[MeetingFeaturesConfiguration] = None,
primary_meeting_id: Optional[PrimaryMeetingId] = None,
tenant_ids: Optional[TenantIdList] = None,
tags: Optional[TagList] = None,
media_placement_network_type: Optional[MediaPlacementNetworkType] = None,
) -> CreateMeetingResponse
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial 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. -
notifications_configuration(Optional[NotificationsConfiguration], default:None) –The configuration for resource targets to receive notifications when meeting and attendee events occur.
-
meeting_features(Optional[MeetingFeaturesConfiguration], default:None) –Lists the audio and video features enabled for a meeting, such as echo reduction.
-
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) –Applies one or more tags to an Amazon Chime SDK meeting. Note the following:
-
Not all resources have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.
-
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.
-
You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.
-
To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
Minimum permissions
In addition to the
tag:TagResourcespermission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag aChimeSDKMeetingsinstance using theTagResourcesoperation, you must have both of the following permissions:tag:TagResourcesChimeSDKMeetings:CreateTagsSome services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the
s3:GetBucketTaggingpermission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information. -
-
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
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 | |