Chime / Client / create_meeting_with_attendees

create_meeting_with_attendees

Chime.Client.create_meeting_with_attendees(**kwargs)

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions 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 .

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.create_meeting_with_attendees(
    ClientRequestToken='string',
    ExternalMeetingId='string',
    MeetingHostId='string',
    MediaRegion='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    NotificationsConfiguration={
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    },
    Attendees=[
        {
            'ExternalUserId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

• ClientRequestToken (string) –

  [REQUIRED]

  The unique identifier for the client request. Use a different token for different meetings.

  This field is autopopulated if not provided.

• ExternalMeetingId (string) – The external meeting ID.

• MeetingHostId (string) – Reserved.

• MediaRegion (string) –

  The Region in which to create the meeting. Default: us-east-1 .

  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 .

• Tags (list) –

  The tag key-value pairs.

  • (dict) –

    Describes a tag applied to a resource.

    • Key (string) – [REQUIRED]

      The key of the tag.

    • Value (string) – [REQUIRED]

      The value of the tag.

• NotificationsConfiguration (dict) –

  The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).

  • SnsTopicArn (string) –

    The SNS topic ARN.

  • SqsQueueArn (string) –

    The SQS queue ARN.

• Attendees (list) –

  The request containing the attendees to create.

  • (dict) –

    The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

    • ExternalUserId (string) – [REQUIRED]

      The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

    • Tags (list) –

      The tag key-value pairs.

      • (dict) –

        Describes a tag applied to a resource.

        • Key (string) – [REQUIRED]

          The key of the tag.

        • Value (string) – [REQUIRED]

          The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string',
            'EventIngestionUrl': 'string'
        },
        'MediaRegion': 'string'
    },
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Meeting (dict) –

    A meeting created using the Amazon Chime SDK.

    • MeetingId (string) –

      The Amazon Chime SDK meeting ID.

    • ExternalMeetingId (string) –

      The external meeting ID.

    • MediaPlacement (dict) –

      The media placement for the meeting.

      • AudioHostUrl (string) –

        The audio host URL.

      • AudioFallbackUrl (string) –

        The audio fallback URL.

      • ScreenDataUrl (string) –

        The screen data URL.

        Warning

        This parameter is is no longer supported and no longer used by the Amazon Chime SDK.

      • ScreenSharingUrl (string) –

        The screen sharing URL.

        Warning

        This parameter is is no longer supported and no longer used by the Amazon Chime SDK..

      • ScreenViewingUrl (string) –

        The screen viewing URL.

        Warning

        This parameter is is no longer supported and no longer used by the Amazon Chime SDK.

      • SignalingUrl (string) –

        The signaling URL.

      • TurnControlUrl (string) –

        The turn control URL.

        Warning

        This parameter is is no longer supported and no longer used by the Amazon Chime SDK.

      • EventIngestionUrl (string) –

        The event ingestion URL to which you send client meeting events.

    • MediaRegion (string) –

      The Region in which you 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.

  • Attendees (list) –

    The attendee information, including attendees IDs and join tokens.

    • (dict) –

      An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

      We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

      • ExternalUserId (string) –

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      • AttendeeId (string) –

        The Amazon Chime SDK attendee ID.

      • JoinToken (string) –

        The join token used by the Amazon Chime SDK attendee.

  • Errors (list) –

    If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

    • (dict) –

      The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

      • ExternalUserId (string) –

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      • ErrorCode (string) –

        The error code.

      • ErrorMessage (string) –

        The error message.

Exceptions

• Chime.Client.exceptions.BadRequestException

• Chime.Client.exceptions.ForbiddenException

• Chime.Client.exceptions.ResourceLimitExceededException

• Chime.Client.exceptions.ThrottledClientException

• Chime.Client.exceptions.UnauthorizedClientException

• Chime.Client.exceptions.ServiceUnavailableException

• Chime.Client.exceptions.ServiceFailureException