Amazon Chime

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken . Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.delete_attendee(
    MeetingId='string',
    AttendeeId='string'
)

type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

type AttendeeId

string

param AttendeeId

[REQUIRED]

The Amazon Chime SDK attendee ID.

returns

None

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.get_attendee(
    MeetingId='string',
    AttendeeId='string'
)

type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

type AttendeeId

string

param AttendeeId

[REQUIRED]

The Amazon Chime SDK attendee ID.

rtype

dict

returns

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string'
    }
}

Response Structure

• (dict) --

  • Attendee (dict) --

    The Amazon Chime SDK attendee information.

    • ExternalUserId (string) --

      The Amazon Chime SDK external user ID. 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.

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.get_meeting(
    MeetingId='string'
)

type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

rtype

dict

returns

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

• (dict) --

  • Meeting (dict) --

    The Amazon Chime SDK meeting information.

    • MeetingId (string) --

      The Amazon Chime SDK meeting ID.

    • MediaPlacement (dict) --

      The media placement for the meeting.

      • AudioHostUrl (string) --

        The audio host URL.

      • ScreenDataUrl (string) --

        The screen data URL.

      • ScreenSharingUrl (string) --

        The screen sharing URL.

      • ScreenViewingUrl (string) --

        The screen viewing URL.

      • SignalingUrl (string) --

        The signaling URL.

      • TurnControlUrl (string) --

        The turn control URL.

    • MediaRegion (string) --

      The Region in which to create the meeting. Available values: us-east-1 , us-west-2 .

Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.batch_create_attendee(
    MeetingId='string',
    Attendees=[
        {
            'ExternalUserId': 'string'
        },
    ]
)

type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

type Attendees

list

param Attendees

[REQUIRED]

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. Links the attendee to an identity managed by a builder application.

rtype

dict

returns

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • 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. 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. Links the attendee to an identity managed by a builder application.

      • ErrorCode (string) --

        The error code.

      • ErrorMessage (string) --

        The error message.

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_meeting(
    ClientRequestToken='string',
    MeetingHostId='string',
    MediaRegion='string',
    NotificationsConfiguration={
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    }
)

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

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

This field is autopopulated if not provided.

type MeetingHostId

string

param MeetingHostId

Reserved.

type MediaRegion

string

param MediaRegion

The Region in which to create the meeting. Available values: us-east-1 , us-west-2 .

type NotificationsConfiguration

dict

param NotificationsConfiguration

The configuration for resource targets to receive notifications when meeting and attendee events occur.

• SnsTopicArn (string) --

  The SNS topic ARN.

• SqsQueueArn (string) --

  The SQS queue ARN.

rtype

dict

returns

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

• (dict) --

  • Meeting (dict) --

    The meeting information, including the meeting ID and MediaPlacement .

    • MeetingId (string) --

      The Amazon Chime SDK meeting ID.

    • MediaPlacement (dict) --

      The media placement for the meeting.

      • AudioHostUrl (string) --

        The audio host URL.

      • ScreenDataUrl (string) --

        The screen data URL.

      • ScreenSharingUrl (string) --

        The screen sharing URL.

      • ScreenViewingUrl (string) --

        The screen viewing URL.

      • SignalingUrl (string) --

        The signaling URL.

      • TurnControlUrl (string) --

        The turn control URL.

    • MediaRegion (string) --

      The Region in which to create the meeting. Available values: us-east-1 , us-west-2 .

Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.delete_meeting(
    MeetingId='string'
)

type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

returns

None

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.list_meetings(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Meetings': [
        {
            'MeetingId': 'string',
            'MediaPlacement': {
                'AudioHostUrl': 'string',
                'ScreenDataUrl': 'string',
                'ScreenSharingUrl': 'string',
                'ScreenViewingUrl': 'string',
                'SignalingUrl': 'string',
                'TurnControlUrl': 'string'
            },
            'MediaRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Meetings (list) --

    The Amazon Chime SDK meeting information.

    • (dict) --

      A meeting created using the Amazon Chime SDK.

      • MeetingId (string) --

        The Amazon Chime SDK meeting ID.

      • MediaPlacement (dict) --

        The media placement for the meeting.

        • AudioHostUrl (string) --

          The audio host URL.

        • ScreenDataUrl (string) --

          The screen data URL.

        • ScreenSharingUrl (string) --

          The screen sharing URL.

        • ScreenViewingUrl (string) --

          The screen viewing URL.

        • SignalingUrl (string) --

          The signaling URL.

        • TurnControlUrl (string) --

          The turn control URL.

      • MediaRegion (string) --

        The Region in which to create the meeting. Available values: us-east-1 , us-west-2 .

  • NextToken (string) --

    The token to use to retrieve the next page of results.

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_attendee(
    MeetingId='string',
    ExternalUserId='string'
)

type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

type ExternalUserId

string

param ExternalUserId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string'
    }
}

Response Structure

• (dict) --

  • Attendee (dict) --

    The attendee information, including attendee ID and join token.

    • ExternalUserId (string) --

      The Amazon Chime SDK external user ID. 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.

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

client.list_attendees(
    MeetingId='string',
    NextToken='string',
    MaxResults=123
)

type MeetingId

string

param MeetingId

[REQUIRED]

The Amazon Chime SDK meeting ID.

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Attendees (list) --

    The Amazon Chime SDK attendee information.

    • (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. 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.

  • NextToken (string) --

    The token to use to retrieve the next page of results.