Skip to content

Type definitions#

Index > ChimeSDKMeetings > Type definitions

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

AttendeeCapabilitiesTypeDef#

# AttendeeCapabilitiesTypeDef definition

class AttendeeCapabilitiesTypeDef(TypedDict):
    Audio: MediaCapabilitiesType,  # (1)
    Video: MediaCapabilitiesType,  # (1)
    Content: MediaCapabilitiesType,  # (1)
  1. See MediaCapabilitiesType
  2. See MediaCapabilitiesType
  3. See MediaCapabilitiesType

AttendeeFeaturesTypeDef#

# AttendeeFeaturesTypeDef definition

class AttendeeFeaturesTypeDef(TypedDict):
    MaxCount: NotRequired[int],

AttendeeIdItemTypeDef#

# AttendeeIdItemTypeDef definition

class AttendeeIdItemTypeDef(TypedDict):
    AttendeeId: str,

AudioFeaturesTypeDef#

# AudioFeaturesTypeDef definition

class AudioFeaturesTypeDef(TypedDict):
    EchoReduction: NotRequired[MeetingFeatureStatusType],  # (1)
  1. See MeetingFeatureStatusType

CreateAttendeeErrorTypeDef#

# CreateAttendeeErrorTypeDef definition

class CreateAttendeeErrorTypeDef(TypedDict):
    ExternalUserId: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ContentFeaturesTypeDef#

# ContentFeaturesTypeDef definition

class ContentFeaturesTypeDef(TypedDict):
    MaxResolution: NotRequired[ContentResolutionType],  # (1)
  1. See ContentResolutionType

NotificationsConfigurationTypeDef#

# NotificationsConfigurationTypeDef definition

class NotificationsConfigurationTypeDef(TypedDict):
    LambdaFunctionArn: NotRequired[str],
    SnsTopicArn: NotRequired[str],
    SqsQueueArn: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

DeleteAttendeeRequestRequestTypeDef#

# DeleteAttendeeRequestRequestTypeDef definition

class DeleteAttendeeRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    AttendeeId: str,

DeleteMeetingRequestRequestTypeDef#

# DeleteMeetingRequestRequestTypeDef definition

class DeleteMeetingRequestRequestTypeDef(TypedDict):
    MeetingId: str,

EngineTranscribeMedicalSettingsTypeDef#

# EngineTranscribeMedicalSettingsTypeDef definition

class EngineTranscribeMedicalSettingsTypeDef(TypedDict):
    LanguageCode: TranscribeMedicalLanguageCodeType,  # (1)
    Specialty: TranscribeMedicalSpecialtyType,  # (2)
    Type: TranscribeMedicalTypeType,  # (3)
    VocabularyName: NotRequired[str],
    Region: NotRequired[TranscribeMedicalRegionType],  # (4)
    ContentIdentificationType: NotRequired[TranscribeMedicalContentIdentificationTypeType],  # (5)
  1. See TranscribeMedicalLanguageCodeType
  2. See TranscribeMedicalSpecialtyType
  3. See TranscribeMedicalTypeType
  4. See TranscribeMedicalRegionType
  5. See TranscribeMedicalContentIdentificationTypeType

EngineTranscribeSettingsTypeDef#

# EngineTranscribeSettingsTypeDef definition

class EngineTranscribeSettingsTypeDef(TypedDict):
    LanguageCode: NotRequired[TranscribeLanguageCodeType],  # (1)
    VocabularyFilterMethod: NotRequired[TranscribeVocabularyFilterMethodType],  # (2)
    VocabularyFilterName: NotRequired[str],
    VocabularyName: NotRequired[str],
    Region: NotRequired[TranscribeRegionType],  # (3)
    EnablePartialResultsStabilization: NotRequired[bool],
    PartialResultsStability: NotRequired[TranscribePartialResultsStabilityType],  # (4)
    ContentIdentificationType: NotRequired[TranscribeContentIdentificationTypeType],  # (5)
    ContentRedactionType: NotRequired[TranscribeContentRedactionTypeType],  # (6)
    PiiEntityTypes: NotRequired[str],
    LanguageModelName: NotRequired[str],
    IdentifyLanguage: NotRequired[bool],
    LanguageOptions: NotRequired[str],
    PreferredLanguage: NotRequired[TranscribeLanguageCodeType],  # (1)
    VocabularyNames: NotRequired[str],
    VocabularyFilterNames: NotRequired[str],
  1. See TranscribeLanguageCodeType
  2. See TranscribeVocabularyFilterMethodType
  3. See TranscribeRegionType
  4. See TranscribePartialResultsStabilityType
  5. See TranscribeContentIdentificationTypeType
  6. See TranscribeContentRedactionTypeType
  7. See TranscribeLanguageCodeType

GetAttendeeRequestRequestTypeDef#

# GetAttendeeRequestRequestTypeDef definition

class GetAttendeeRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    AttendeeId: str,

GetMeetingRequestRequestTypeDef#

# GetMeetingRequestRequestTypeDef definition

class GetMeetingRequestRequestTypeDef(TypedDict):
    MeetingId: str,

ListAttendeesRequestRequestTypeDef#

# ListAttendeesRequestRequestTypeDef definition

class ListAttendeesRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

MediaPlacementTypeDef#

# MediaPlacementTypeDef definition

class MediaPlacementTypeDef(TypedDict):
    AudioHostUrl: NotRequired[str],
    AudioFallbackUrl: NotRequired[str],
    SignalingUrl: NotRequired[str],
    TurnControlUrl: NotRequired[str],
    ScreenDataUrl: NotRequired[str],
    ScreenViewingUrl: NotRequired[str],
    ScreenSharingUrl: NotRequired[str],
    EventIngestionUrl: NotRequired[str],

VideoFeaturesTypeDef#

# VideoFeaturesTypeDef definition

class VideoFeaturesTypeDef(TypedDict):
    MaxResolution: NotRequired[VideoResolutionType],  # (1)
  1. See VideoResolutionType

StopMeetingTranscriptionRequestRequestTypeDef#

# StopMeetingTranscriptionRequestRequestTypeDef definition

class StopMeetingTranscriptionRequestRequestTypeDef(TypedDict):
    MeetingId: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

AttendeeTypeDef#

# AttendeeTypeDef definition

class AttendeeTypeDef(TypedDict):
    ExternalUserId: NotRequired[str],
    AttendeeId: NotRequired[str],
    JoinToken: NotRequired[str],
    Capabilities: NotRequired[AttendeeCapabilitiesTypeDef],  # (1)
  1. See AttendeeCapabilitiesTypeDef

CreateAttendeeRequestItemTypeDef#

# CreateAttendeeRequestItemTypeDef definition

class CreateAttendeeRequestItemTypeDef(TypedDict):
    ExternalUserId: str,
    Capabilities: NotRequired[AttendeeCapabilitiesTypeDef],  # (1)
  1. See AttendeeCapabilitiesTypeDef

CreateAttendeeRequestRequestTypeDef#

# CreateAttendeeRequestRequestTypeDef definition

class CreateAttendeeRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    ExternalUserId: str,
    Capabilities: NotRequired[AttendeeCapabilitiesTypeDef],  # (1)
  1. See AttendeeCapabilitiesTypeDef

UpdateAttendeeCapabilitiesRequestRequestTypeDef#

# UpdateAttendeeCapabilitiesRequestRequestTypeDef definition

class UpdateAttendeeCapabilitiesRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    AttendeeId: str,
    Capabilities: AttendeeCapabilitiesTypeDef,  # (1)
  1. See AttendeeCapabilitiesTypeDef

BatchUpdateAttendeeCapabilitiesExceptRequestRequestTypeDef#

# BatchUpdateAttendeeCapabilitiesExceptRequestRequestTypeDef definition

class BatchUpdateAttendeeCapabilitiesExceptRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    ExcludedAttendeeIds: Sequence[AttendeeIdItemTypeDef],  # (1)
    Capabilities: AttendeeCapabilitiesTypeDef,  # (2)
  1. See AttendeeIdItemTypeDef
  2. See AttendeeCapabilitiesTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

TranscriptionConfigurationTypeDef#

# TranscriptionConfigurationTypeDef definition

class TranscriptionConfigurationTypeDef(TypedDict):
    EngineTranscribeSettings: NotRequired[EngineTranscribeSettingsTypeDef],  # (1)
    EngineTranscribeMedicalSettings: NotRequired[EngineTranscribeMedicalSettingsTypeDef],  # (2)
  1. See EngineTranscribeSettingsTypeDef
  2. See EngineTranscribeMedicalSettingsTypeDef

MeetingFeaturesConfigurationTypeDef#

# MeetingFeaturesConfigurationTypeDef definition

class MeetingFeaturesConfigurationTypeDef(TypedDict):
    Audio: NotRequired[AudioFeaturesTypeDef],  # (1)
    Video: NotRequired[VideoFeaturesTypeDef],  # (2)
    Content: NotRequired[ContentFeaturesTypeDef],  # (3)
    Attendee: NotRequired[AttendeeFeaturesTypeDef],  # (4)
  1. See AudioFeaturesTypeDef
  2. See VideoFeaturesTypeDef
  3. See ContentFeaturesTypeDef
  4. See AttendeeFeaturesTypeDef

BatchCreateAttendeeResponseTypeDef#

# BatchCreateAttendeeResponseTypeDef definition

class BatchCreateAttendeeResponseTypeDef(TypedDict):
    Attendees: List[AttendeeTypeDef],  # (1)
    Errors: List[CreateAttendeeErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AttendeeTypeDef
  2. See CreateAttendeeErrorTypeDef
  3. See ResponseMetadataTypeDef

CreateAttendeeResponseTypeDef#

# CreateAttendeeResponseTypeDef definition

class CreateAttendeeResponseTypeDef(TypedDict):
    Attendee: AttendeeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AttendeeTypeDef
  2. See ResponseMetadataTypeDef

GetAttendeeResponseTypeDef#

# GetAttendeeResponseTypeDef definition

class GetAttendeeResponseTypeDef(TypedDict):
    Attendee: AttendeeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AttendeeTypeDef
  2. See ResponseMetadataTypeDef

ListAttendeesResponseTypeDef#

# ListAttendeesResponseTypeDef definition

class ListAttendeesResponseTypeDef(TypedDict):
    Attendees: List[AttendeeTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AttendeeTypeDef
  2. See ResponseMetadataTypeDef

UpdateAttendeeCapabilitiesResponseTypeDef#

# UpdateAttendeeCapabilitiesResponseTypeDef definition

class UpdateAttendeeCapabilitiesResponseTypeDef(TypedDict):
    Attendee: AttendeeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AttendeeTypeDef
  2. See ResponseMetadataTypeDef

BatchCreateAttendeeRequestRequestTypeDef#

# BatchCreateAttendeeRequestRequestTypeDef definition

class BatchCreateAttendeeRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef],  # (1)
  1. See CreateAttendeeRequestItemTypeDef

StartMeetingTranscriptionRequestRequestTypeDef#

# StartMeetingTranscriptionRequestRequestTypeDef definition

class StartMeetingTranscriptionRequestRequestTypeDef(TypedDict):
    MeetingId: str,
    TranscriptionConfiguration: TranscriptionConfigurationTypeDef,  # (1)
  1. See TranscriptionConfigurationTypeDef

CreateMeetingRequestRequestTypeDef#

# CreateMeetingRequestRequestTypeDef definition

class CreateMeetingRequestRequestTypeDef(TypedDict):
    ClientRequestToken: str,
    MediaRegion: str,
    ExternalMeetingId: str,
    MeetingHostId: NotRequired[str],
    NotificationsConfiguration: NotRequired[NotificationsConfigurationTypeDef],  # (1)
    MeetingFeatures: NotRequired[MeetingFeaturesConfigurationTypeDef],  # (2)
    PrimaryMeetingId: NotRequired[str],
    TenantIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See NotificationsConfigurationTypeDef
  2. See MeetingFeaturesConfigurationTypeDef
  3. See TagTypeDef

CreateMeetingWithAttendeesRequestRequestTypeDef#

# CreateMeetingWithAttendeesRequestRequestTypeDef definition

class CreateMeetingWithAttendeesRequestRequestTypeDef(TypedDict):
    ClientRequestToken: str,
    MediaRegion: str,
    ExternalMeetingId: str,
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef],  # (1)
    MeetingHostId: NotRequired[str],
    MeetingFeatures: NotRequired[MeetingFeaturesConfigurationTypeDef],  # (2)
    NotificationsConfiguration: NotRequired[NotificationsConfigurationTypeDef],  # (3)
    PrimaryMeetingId: NotRequired[str],
    TenantIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See CreateAttendeeRequestItemTypeDef
  2. See MeetingFeaturesConfigurationTypeDef
  3. See NotificationsConfigurationTypeDef
  4. See TagTypeDef

MeetingTypeDef#

# MeetingTypeDef definition

class MeetingTypeDef(TypedDict):
    MeetingId: NotRequired[str],
    MeetingHostId: NotRequired[str],
    ExternalMeetingId: NotRequired[str],
    MediaRegion: NotRequired[str],
    MediaPlacement: NotRequired[MediaPlacementTypeDef],  # (1)
    MeetingFeatures: NotRequired[MeetingFeaturesConfigurationTypeDef],  # (2)
    PrimaryMeetingId: NotRequired[str],
    TenantIds: NotRequired[List[str]],
    MeetingArn: NotRequired[str],
  1. See MediaPlacementTypeDef
  2. See MeetingFeaturesConfigurationTypeDef

CreateMeetingResponseTypeDef#

# CreateMeetingResponseTypeDef definition

class CreateMeetingResponseTypeDef(TypedDict):
    Meeting: MeetingTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MeetingTypeDef
  2. See ResponseMetadataTypeDef

CreateMeetingWithAttendeesResponseTypeDef#

# CreateMeetingWithAttendeesResponseTypeDef definition

class CreateMeetingWithAttendeesResponseTypeDef(TypedDict):
    Meeting: MeetingTypeDef,  # (1)
    Attendees: List[AttendeeTypeDef],  # (2)
    Errors: List[CreateAttendeeErrorTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See MeetingTypeDef
  2. See AttendeeTypeDef
  3. See CreateAttendeeErrorTypeDef
  4. See ResponseMetadataTypeDef

GetMeetingResponseTypeDef#

# GetMeetingResponseTypeDef definition

class GetMeetingResponseTypeDef(TypedDict):
    Meeting: MeetingTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MeetingTypeDef
  2. See ResponseMetadataTypeDef