Skip to content

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:

Source code in docs_src/capo_chime_sdk_meetings/_services/async_chime_sdk_meetings.py
async def create_meeting_with_attendees(
    self,
    client_request_token: "capo_chime_sdk_meetings.types.client_request_token.ClientRequestToken",
    media_region: "capo_chime_sdk_meetings.types.media_region.MediaRegion",
    external_meeting_id: "capo_chime_sdk_meetings.types.external_meeting_id.ExternalMeetingId",
    attendees: "capo_chime_sdk_meetings.types.create_meeting_with_attendees_request_item_list.CreateMeetingWithAttendeesRequestItemList",
    *,
    config_overrides: Optional[AsyncChimeSDKMeetingsClientConfig] = None,
    meeting_host_id: Optional[
        "capo_chime_sdk_meetings.types.external_user_id.ExternalUserId"
    ] = None,
    meeting_features: Optional[
        "capo_chime_sdk_meetings.types.meeting_features_configuration.MeetingFeaturesConfiguration"
    ] = None,
    notifications_configuration: Optional[
        "capo_chime_sdk_meetings.types.notifications_configuration.NotificationsConfiguration"
    ] = None,
    primary_meeting_id: Optional[
        "capo_chime_sdk_meetings.types.primary_meeting_id.PrimaryMeetingId"
    ] = None,
    tenant_ids: Optional[
        "capo_chime_sdk_meetings.types.tenant_id_list.TenantIdList"
    ] = None,
    tags: Optional["capo_chime_sdk_meetings.types.tag_list.TagList"] = None,
    media_placement_network_type: Optional[
        "capo_chime_sdk_meetings.types.media_placement_network_type.MediaPlacementNetworkType"
    ] = None,
) -> "capo_chime_sdk_meetings.types.create_meeting_with_attendees_response.CreateMeetingWithAttendeesResponse":
    r"""<p> Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/sdk-available-regions">Available Regions</a> and <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html">Using meeting Regions</a>, both in the <i>Amazon Chime SDK Developer Guide</i>. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime SDK Developer Guide</i>. </p> <note> <p>If you use this API in conjuction with the and APIs, and you don't specify the <code>MeetingFeatures.Content.MaxResolution</code> or <code>MeetingFeatures.Video.MaxResolution</code> parameters, the following defaults are used:</p> <ul> <li> <p>Content.MaxResolution: FHD</p> </li> <li> <p>Video.MaxResolution: HD</p> </li> </ul> </note>

    Args:
        client_request_token: <p>The unique identifier for the client request. Use a different token for different meetings.</p>
        media_region: <p>The Region in which to create the meeting.</p> <p> Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>. </p> <p>Available values in Amazon Web Services GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
        meeting_host_id: <p>Reserved.</p>
        external_meeting_id: <p>The external meeting ID.</p> <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code> </p> <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix. Case insensitive.</p>
        meeting_features: <p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>
        notifications_configuration: <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
        attendees: <p>The attendee information, including attendees' IDs and join tokens.</p>
        primary_meeting_id: <p>When specified, replicates the media from the primary meeting to the new meeting.</p>
        tenant_ids: <p>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</p>
        tags: <p>The tags in the request.</p>
        media_placement_network_type: <p>The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).</p>

    Raises:
        capo_chime_sdk_meetings.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_meetings.errors.conflict_exception.ConflictException: <p>Multiple instances of the same request have been made simultaneously.</p>
        capo_chime_sdk_meetings.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_meetings.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime_sdk_meetings.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_meetings.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_meetings.errors.throttling_exception.ThrottlingException: <p>The number of customer requests exceeds the request rate limit.</p>
        capo_chime_sdk_meetings.errors.unauthorized_exception.UnauthorizedException: <p>The user isn't authorized to request a resource.</p>
        capo_chime_sdk_meetings.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_meetings.types.create_meeting_with_attendees_request.CreateMeetingWithAttendeesRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_meetings.types.create_meeting_with_attendees_response.CreateMeetingWithAttendeesResponse"
    ]:
        import capo_chime_sdk_meetings._operations.chime_meetings_sdk_service.create_meeting_with_attendees

        (
            output,
            http_response,
        ) = await capo_chime_sdk_meetings._operations.chime_meetings_sdk_service.create_meeting_with_attendees.async_create_meeting_with_attendees(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_meetings.types.create_meeting_with_attendees_request.CreateMeetingWithAttendeesRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_meetings.types.create_meeting_with_attendees_request

        return capo_chime_sdk_meetings.types.create_meeting_with_attendees_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_chime_sdk_meetings.types.create_meeting_with_attendees_response.CreateMeetingWithAttendeesResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_meetings.types.create_meeting_with_attendees_response

        return capo_chime_sdk_meetings.types.create_meeting_with_attendees_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateMeetingWithAttendees",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_meetings.types.create_meeting_with_attendees_request.CreateMeetingWithAttendeesRequest = {
        "client_request_token": client_request_token,
        "media_region": media_region,
        "external_meeting_id": external_meeting_id,
        "attendees": attendees,
    }
    if meeting_host_id is not None:
        input_["meeting_host_id"] = meeting_host_id
    if meeting_features is not None:
        input_["meeting_features"] = meeting_features
    if notifications_configuration is not None:
        input_["notifications_configuration"] = notifications_configuration
    if primary_meeting_id is not None:
        input_["primary_meeting_id"] = primary_meeting_id
    if tenant_ids is not None:
        input_["tenant_ids"] = tenant_ids
    if tags is not None:
        input_["tags"] = tags
    if media_placement_network_type is not None:
        input_["media_placement_network_type"] = media_placement_network_type

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output