Skip to content

ChimeSDKMeetingsClient

Index > ChimeSDKMeetings > ChimeSDKMeetingsClient

Auto-generated documentation for ChimeSDKMeetings type annotations stubs module mypy-boto3-chime-sdk-meetings.

ChimeSDKMeetingsClient

Type annotations and code completion for boto3.client("chime-sdk-meetings"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_chime_sdk_meetings.client import ChimeSDKMeetingsClient

def get_chime-sdk-meetings_client() -> ChimeSDKMeetingsClient:
    return Session().client("chime-sdk-meetings")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("chime-sdk-meetings").exceptions structure.

Usage example
client = boto3.client("chime-sdk-meetings")

try:
    do_something(client)
except (
    client.BadRequestException,
    client.ClientError,
    client.ConflictException,
    client.ForbiddenException,
    client.LimitExceededException,
    client.NotFoundException,
    client.ResourceNotFoundException,
    client.ServiceFailureException,
    client.ServiceUnavailableException,
    client.ThrottlingException,
    client.TooManyTagsException,
    client.UnauthorizedException,
    client.UnprocessableEntityException,
) as e:
    print(e)
Type checking example
from mypy_boto3_chime_sdk_meetings.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

batch_create_attendee

Creates up to 100 attendees for an active Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime-sdk-meetings").batch_create_attendee method. boto3 documentation

Method definition
def batch_create_attendee(
    self,
    *,
    MeetingId: str,
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef],  # (1)
) -> BatchCreateAttendeeResponseTypeDef:  # (2)
    ...
  1. See CreateAttendeeRequestItemTypeDef
  2. See BatchCreateAttendeeResponseTypeDef
Usage example with kwargs
kwargs: BatchCreateAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "Attendees": ...,
}

parent.batch_create_attendee(**kwargs)
  1. See BatchCreateAttendeeRequestRequestTypeDef

batch_update_attendee_capabilities_except

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

Type annotations and code completion for boto3.client("chime-sdk-meetings").batch_update_attendee_capabilities_except method. boto3 documentation

Method definition
def batch_update_attendee_capabilities_except(
    self,
    *,
    MeetingId: str,
    ExcludedAttendeeIds: Sequence[AttendeeIdItemTypeDef],  # (1)
    Capabilities: AttendeeCapabilitiesTypeDef,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See AttendeeIdItemTypeDef
  2. See AttendeeCapabilitiesTypeDef
  3. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: BatchUpdateAttendeeCapabilitiesExceptRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "ExcludedAttendeeIds": ...,
    "Capabilities": ...,
}

parent.batch_update_attendee_capabilities_except(**kwargs)
  1. See BatchUpdateAttendeeCapabilitiesExceptRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("chime-sdk-meetings").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("chime-sdk-meetings").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_attendee

Creates a new attendee for an active Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime-sdk-meetings").create_attendee method. boto3 documentation

Method definition
def create_attendee(
    self,
    *,
    MeetingId: str,
    ExternalUserId: str,
    Capabilities: AttendeeCapabilitiesTypeDef = ...,  # (1)
) -> CreateAttendeeResponseTypeDef:  # (2)
    ...
  1. See AttendeeCapabilitiesTypeDef
  2. See CreateAttendeeResponseTypeDef
Usage example with kwargs
kwargs: CreateAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "ExternalUserId": ...,
}

parent.create_attendee(**kwargs)
  1. See CreateAttendeeRequestRequestTypeDef

create_meeting

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

Type annotations and code completion for boto3.client("chime-sdk-meetings").create_meeting method. boto3 documentation

Method definition
def create_meeting(
    self,
    *,
    ClientRequestToken: str,
    MediaRegion: str,
    ExternalMeetingId: str,
    MeetingHostId: str = ...,
    NotificationsConfiguration: NotificationsConfigurationTypeDef = ...,  # (1)
    MeetingFeatures: MeetingFeaturesConfigurationTypeDef = ...,  # (2)
    PrimaryMeetingId: str = ...,
    TenantIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateMeetingResponseTypeDef:  # (4)
    ...
  1. See NotificationsConfigurationTypeDef
  2. See MeetingFeaturesConfigurationTypeDef
  3. See TagTypeDef
  4. See CreateMeetingResponseTypeDef
Usage example with kwargs
kwargs: CreateMeetingRequestRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
    "MediaRegion": ...,
    "ExternalMeetingId": ...,
}

parent.create_meeting(**kwargs)
  1. See CreateMeetingRequestRequestTypeDef

create_meeting_with_attendees

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

Type annotations and code completion for boto3.client("chime-sdk-meetings").create_meeting_with_attendees method. boto3 documentation

Method definition
def create_meeting_with_attendees(
    self,
    *,
    ClientRequestToken: str,
    MediaRegion: str,
    ExternalMeetingId: str,
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef],  # (1)
    MeetingHostId: str = ...,
    MeetingFeatures: MeetingFeaturesConfigurationTypeDef = ...,  # (2)
    NotificationsConfiguration: NotificationsConfigurationTypeDef = ...,  # (3)
    PrimaryMeetingId: str = ...,
    TenantIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateMeetingWithAttendeesResponseTypeDef:  # (5)
    ...
  1. See CreateAttendeeRequestItemTypeDef
  2. See MeetingFeaturesConfigurationTypeDef
  3. See NotificationsConfigurationTypeDef
  4. See TagTypeDef
  5. See CreateMeetingWithAttendeesResponseTypeDef
Usage example with kwargs
kwargs: CreateMeetingWithAttendeesRequestRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
    "MediaRegion": ...,
    "ExternalMeetingId": ...,
    "Attendees": ...,
}

parent.create_meeting_with_attendees(**kwargs)
  1. See CreateMeetingWithAttendeesRequestRequestTypeDef

delete_attendee

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

Type annotations and code completion for boto3.client("chime-sdk-meetings").delete_attendee method. boto3 documentation

Method definition
def delete_attendee(
    self,
    *,
    MeetingId: str,
    AttendeeId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
}

parent.delete_attendee(**kwargs)
  1. See DeleteAttendeeRequestRequestTypeDef

delete_meeting

Deletes the specified Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime-sdk-meetings").delete_meeting method. boto3 documentation

Method definition
def delete_meeting(
    self,
    *,
    MeetingId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteMeetingRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.delete_meeting(**kwargs)
  1. See DeleteMeetingRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("chime-sdk-meetings").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_attendee

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.

Type annotations and code completion for boto3.client("chime-sdk-meetings").get_attendee method. boto3 documentation

Method definition
def get_attendee(
    self,
    *,
    MeetingId: str,
    AttendeeId: str,
) -> GetAttendeeResponseTypeDef:  # (1)
    ...
  1. See GetAttendeeResponseTypeDef
Usage example with kwargs
kwargs: GetAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
}

parent.get_attendee(**kwargs)
  1. See GetAttendeeRequestRequestTypeDef

get_meeting

Gets the Amazon Chime SDK meeting details for the specified meeting ID.

Type annotations and code completion for boto3.client("chime-sdk-meetings").get_meeting method. boto3 documentation

Method definition
def get_meeting(
    self,
    *,
    MeetingId: str,
) -> GetMeetingResponseTypeDef:  # (1)
    ...
  1. See GetMeetingResponseTypeDef
Usage example with kwargs
kwargs: GetMeetingRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.get_meeting(**kwargs)
  1. See GetMeetingRequestRequestTypeDef

list_attendees

Lists the attendees for the specified Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime-sdk-meetings").list_attendees method. boto3 documentation

Method definition
def list_attendees(
    self,
    *,
    MeetingId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAttendeesResponseTypeDef:  # (1)
    ...
  1. See ListAttendeesResponseTypeDef
Usage example with kwargs
kwargs: ListAttendeesRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.list_attendees(**kwargs)
  1. See ListAttendeesRequestRequestTypeDef

list_tags_for_resource

Returns a list of the tags available for the specified resource.

Type annotations and code completion for boto3.client("chime-sdk-meetings").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_meeting_transcription

Starts transcription for the specified meetingId.

Type annotations and code completion for boto3.client("chime-sdk-meetings").start_meeting_transcription method. boto3 documentation

Method definition
def start_meeting_transcription(
    self,
    *,
    MeetingId: str,
    TranscriptionConfiguration: TranscriptionConfigurationTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TranscriptionConfigurationTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: StartMeetingTranscriptionRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "TranscriptionConfiguration": ...,
}

parent.start_meeting_transcription(**kwargs)
  1. See StartMeetingTranscriptionRequestRequestTypeDef

stop_meeting_transcription

Stops transcription for the specified meetingId.

Type annotations and code completion for boto3.client("chime-sdk-meetings").stop_meeting_transcription method. boto3 documentation

Method definition
def stop_meeting_transcription(
    self,
    *,
    MeetingId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: StopMeetingTranscriptionRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.stop_meeting_transcription(**kwargs)
  1. See StopMeetingTranscriptionRequestRequestTypeDef

tag_resource

The resource that supports tags.

Type annotations and code completion for boto3.client("chime-sdk-meetings").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the specified resources.

Type annotations and code completion for boto3.client("chime-sdk-meetings").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_attendee_capabilities

The capabilties that you want to update.

Type annotations and code completion for boto3.client("chime-sdk-meetings").update_attendee_capabilities method. boto3 documentation

Method definition
def update_attendee_capabilities(
    self,
    *,
    MeetingId: str,
    AttendeeId: str,
    Capabilities: AttendeeCapabilitiesTypeDef,  # (1)
) -> UpdateAttendeeCapabilitiesResponseTypeDef:  # (2)
    ...
  1. See AttendeeCapabilitiesTypeDef
  2. See UpdateAttendeeCapabilitiesResponseTypeDef
Usage example with kwargs
kwargs: UpdateAttendeeCapabilitiesRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
    "Capabilities": ...,
}

parent.update_attendee_capabilities(**kwargs)
  1. See UpdateAttendeeCapabilitiesRequestRequestTypeDef