Skip to content

Type definitions#

Index > AlexaForBusiness > Type definitions

Auto-generated documentation for AlexaForBusiness type annotations stubs module mypy-boto3-alexaforbusiness.

AddressBookDataTypeDef#

# AddressBookDataTypeDef definition

class AddressBookDataTypeDef(TypedDict):
    AddressBookArn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],

AddressBookTypeDef#

# AddressBookTypeDef definition

class AddressBookTypeDef(TypedDict):
    AddressBookArn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],

ApproveSkillRequestRequestTypeDef#

# ApproveSkillRequestRequestTypeDef definition

class ApproveSkillRequestRequestTypeDef(TypedDict):
    SkillId: str,

AssociateContactWithAddressBookRequestRequestTypeDef#

# AssociateContactWithAddressBookRequestRequestTypeDef definition

class AssociateContactWithAddressBookRequestRequestTypeDef(TypedDict):
    ContactArn: str,
    AddressBookArn: str,

AssociateDeviceWithNetworkProfileRequestRequestTypeDef#

# AssociateDeviceWithNetworkProfileRequestRequestTypeDef definition

class AssociateDeviceWithNetworkProfileRequestRequestTypeDef(TypedDict):
    DeviceArn: str,
    NetworkProfileArn: str,

AssociateDeviceWithRoomRequestRequestTypeDef#

# AssociateDeviceWithRoomRequestRequestTypeDef definition

class AssociateDeviceWithRoomRequestRequestTypeDef(TypedDict):
    DeviceArn: NotRequired[str],
    RoomArn: NotRequired[str],

AssociateSkillGroupWithRoomRequestRequestTypeDef#

# AssociateSkillGroupWithRoomRequestRequestTypeDef definition

class AssociateSkillGroupWithRoomRequestRequestTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],
    RoomArn: NotRequired[str],

AssociateSkillWithSkillGroupRequestRequestTypeDef#

# AssociateSkillWithSkillGroupRequestRequestTypeDef definition

class AssociateSkillWithSkillGroupRequestRequestTypeDef(TypedDict):
    SkillId: str,
    SkillGroupArn: NotRequired[str],

AssociateSkillWithUsersRequestRequestTypeDef#

# AssociateSkillWithUsersRequestRequestTypeDef definition

class AssociateSkillWithUsersRequestRequestTypeDef(TypedDict):
    SkillId: str,

AudioTypeDef#

# AudioTypeDef definition

class AudioTypeDef(TypedDict):
    Locale: LocaleType,  # (1)
    Location: str,
  1. See LocaleType

BusinessReportContentRangeTypeDef#

# BusinessReportContentRangeTypeDef definition

class BusinessReportContentRangeTypeDef(TypedDict):
    Interval: BusinessReportIntervalType,  # (1)
  1. See BusinessReportIntervalType

BusinessReportRecurrenceTypeDef#

# BusinessReportRecurrenceTypeDef definition

class BusinessReportRecurrenceTypeDef(TypedDict):
    StartDate: NotRequired[str],

BusinessReportS3LocationTypeDef#

# BusinessReportS3LocationTypeDef definition

class BusinessReportS3LocationTypeDef(TypedDict):
    Path: NotRequired[str],
    BucketName: NotRequired[str],

CategoryTypeDef#

# CategoryTypeDef definition

class CategoryTypeDef(TypedDict):
    CategoryId: NotRequired[int],
    CategoryName: NotRequired[str],

ConferencePreferenceTypeDef#

# ConferencePreferenceTypeDef definition

class ConferencePreferenceTypeDef(TypedDict):
    DefaultConferenceProviderArn: NotRequired[str],

IPDialInTypeDef#

# IPDialInTypeDef definition

class IPDialInTypeDef(TypedDict):
    Endpoint: str,
    CommsProtocol: CommsProtocolType,  # (1)
  1. See CommsProtocolType

MeetingSettingTypeDef#

# MeetingSettingTypeDef definition

class MeetingSettingTypeDef(TypedDict):
    RequirePin: RequirePinType,  # (1)
  1. See RequirePinType

PSTNDialInTypeDef#

# PSTNDialInTypeDef definition

class PSTNDialInTypeDef(TypedDict):
    CountryCode: str,
    PhoneNumber: str,
    OneClickIdDelay: str,
    OneClickPinDelay: str,

PhoneNumberTypeDef#

# PhoneNumberTypeDef definition

class PhoneNumberTypeDef(TypedDict):
    Number: str,
    Type: PhoneNumberTypeType,  # (1)
  1. See PhoneNumberTypeType

SipAddressTypeDef#

# SipAddressTypeDef definition

class SipAddressTypeDef(TypedDict):
    Uri: str,
    Type: SipTypeType,  # (1)
  1. See SipTypeType

SsmlTypeDef#

# SsmlTypeDef definition

class SsmlTypeDef(TypedDict):
    Locale: LocaleType,  # (1)
    Value: str,
  1. See LocaleType

TextTypeDef#

# TextTypeDef definition

class TextTypeDef(TypedDict):
    Locale: LocaleType,  # (1)
    Value: str,
  1. See LocaleType

TagTypeDef#

# TagTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateEndOfMeetingReminderTypeDef#

# CreateEndOfMeetingReminderTypeDef definition

class CreateEndOfMeetingReminderTypeDef(TypedDict):
    ReminderAtMinutes: Sequence[int],
    ReminderType: EndOfMeetingReminderTypeType,  # (1)
    Enabled: bool,
  1. See EndOfMeetingReminderTypeType

CreateInstantBookingTypeDef#

# CreateInstantBookingTypeDef definition

class CreateInstantBookingTypeDef(TypedDict):
    DurationInMinutes: int,
    Enabled: bool,

CreateProactiveJoinTypeDef#

# CreateProactiveJoinTypeDef definition

class CreateProactiveJoinTypeDef(TypedDict):
    EnabledByMotion: bool,

CreateRequireCheckInTypeDef#

# CreateRequireCheckInTypeDef definition

class CreateRequireCheckInTypeDef(TypedDict):
    ReleaseAfterMinutes: int,
    Enabled: bool,

DeleteAddressBookRequestRequestTypeDef#

# DeleteAddressBookRequestRequestTypeDef definition

class DeleteAddressBookRequestRequestTypeDef(TypedDict):
    AddressBookArn: str,

DeleteBusinessReportScheduleRequestRequestTypeDef#

# DeleteBusinessReportScheduleRequestRequestTypeDef definition

class DeleteBusinessReportScheduleRequestRequestTypeDef(TypedDict):
    ScheduleArn: str,

DeleteConferenceProviderRequestRequestTypeDef#

# DeleteConferenceProviderRequestRequestTypeDef definition

class DeleteConferenceProviderRequestRequestTypeDef(TypedDict):
    ConferenceProviderArn: str,

DeleteContactRequestRequestTypeDef#

# DeleteContactRequestRequestTypeDef definition

class DeleteContactRequestRequestTypeDef(TypedDict):
    ContactArn: str,

DeleteDeviceRequestRequestTypeDef#

# DeleteDeviceRequestRequestTypeDef definition

class DeleteDeviceRequestRequestTypeDef(TypedDict):
    DeviceArn: str,

DeleteDeviceUsageDataRequestRequestTypeDef#

# DeleteDeviceUsageDataRequestRequestTypeDef definition

class DeleteDeviceUsageDataRequestRequestTypeDef(TypedDict):
    DeviceArn: str,
    DeviceUsageType: DeviceUsageTypeType,  # (1)
  1. See DeviceUsageTypeType

DeleteGatewayGroupRequestRequestTypeDef#

# DeleteGatewayGroupRequestRequestTypeDef definition

class DeleteGatewayGroupRequestRequestTypeDef(TypedDict):
    GatewayGroupArn: str,

DeleteNetworkProfileRequestRequestTypeDef#

# DeleteNetworkProfileRequestRequestTypeDef definition

class DeleteNetworkProfileRequestRequestTypeDef(TypedDict):
    NetworkProfileArn: str,

DeleteProfileRequestRequestTypeDef#

# DeleteProfileRequestRequestTypeDef definition

class DeleteProfileRequestRequestTypeDef(TypedDict):
    ProfileArn: NotRequired[str],

DeleteRoomRequestRequestTypeDef#

# DeleteRoomRequestRequestTypeDef definition

class DeleteRoomRequestRequestTypeDef(TypedDict):
    RoomArn: NotRequired[str],

DeleteRoomSkillParameterRequestRequestTypeDef#

# DeleteRoomSkillParameterRequestRequestTypeDef definition

class DeleteRoomSkillParameterRequestRequestTypeDef(TypedDict):
    SkillId: str,
    ParameterKey: str,
    RoomArn: NotRequired[str],

DeleteSkillAuthorizationRequestRequestTypeDef#

# DeleteSkillAuthorizationRequestRequestTypeDef definition

class DeleteSkillAuthorizationRequestRequestTypeDef(TypedDict):
    SkillId: str,
    RoomArn: NotRequired[str],

DeleteSkillGroupRequestRequestTypeDef#

# DeleteSkillGroupRequestRequestTypeDef definition

class DeleteSkillGroupRequestRequestTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],

DeleteUserRequestRequestTypeDef#

# DeleteUserRequestRequestTypeDef definition

class DeleteUserRequestRequestTypeDef(TypedDict):
    EnrollmentId: str,
    UserArn: NotRequired[str],

DeveloperInfoTypeDef#

# DeveloperInfoTypeDef definition

class DeveloperInfoTypeDef(TypedDict):
    DeveloperName: NotRequired[str],
    PrivacyPolicy: NotRequired[str],
    Email: NotRequired[str],
    Url: NotRequired[str],

DeviceEventTypeDef#

# DeviceEventTypeDef definition

class DeviceEventTypeDef(TypedDict):
    Type: NotRequired[DeviceEventTypeType],  # (1)
    Value: NotRequired[str],
    Timestamp: NotRequired[datetime],
  1. See DeviceEventTypeType

DeviceNetworkProfileInfoTypeDef#

# DeviceNetworkProfileInfoTypeDef definition

class DeviceNetworkProfileInfoTypeDef(TypedDict):
    NetworkProfileArn: NotRequired[str],
    CertificateArn: NotRequired[str],
    CertificateExpirationTime: NotRequired[datetime],

DeviceStatusDetailTypeDef#

# DeviceStatusDetailTypeDef definition

class DeviceStatusDetailTypeDef(TypedDict):
    Feature: NotRequired[FeatureType],  # (1)
    Code: NotRequired[DeviceStatusDetailCodeType],  # (2)
  1. See FeatureType
  2. See DeviceStatusDetailCodeType

DisassociateContactFromAddressBookRequestRequestTypeDef#

# DisassociateContactFromAddressBookRequestRequestTypeDef definition

class DisassociateContactFromAddressBookRequestRequestTypeDef(TypedDict):
    ContactArn: str,
    AddressBookArn: str,

DisassociateDeviceFromRoomRequestRequestTypeDef#

# DisassociateDeviceFromRoomRequestRequestTypeDef definition

class DisassociateDeviceFromRoomRequestRequestTypeDef(TypedDict):
    DeviceArn: NotRequired[str],

DisassociateSkillFromSkillGroupRequestRequestTypeDef#

# DisassociateSkillFromSkillGroupRequestRequestTypeDef definition

class DisassociateSkillFromSkillGroupRequestRequestTypeDef(TypedDict):
    SkillId: str,
    SkillGroupArn: NotRequired[str],

DisassociateSkillFromUsersRequestRequestTypeDef#

# DisassociateSkillFromUsersRequestRequestTypeDef definition

class DisassociateSkillFromUsersRequestRequestTypeDef(TypedDict):
    SkillId: str,

DisassociateSkillGroupFromRoomRequestRequestTypeDef#

# DisassociateSkillGroupFromRoomRequestRequestTypeDef definition

class DisassociateSkillGroupFromRoomRequestRequestTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],
    RoomArn: NotRequired[str],

EndOfMeetingReminderTypeDef#

# EndOfMeetingReminderTypeDef definition

class EndOfMeetingReminderTypeDef(TypedDict):
    ReminderAtMinutes: NotRequired[List[int]],
    ReminderType: NotRequired[EndOfMeetingReminderTypeType],  # (1)
    Enabled: NotRequired[bool],
  1. See EndOfMeetingReminderTypeType

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Key: str,
    Values: Sequence[str],

ForgetSmartHomeAppliancesRequestRequestTypeDef#

# ForgetSmartHomeAppliancesRequestRequestTypeDef definition

class ForgetSmartHomeAppliancesRequestRequestTypeDef(TypedDict):
    RoomArn: str,

GatewayGroupSummaryTypeDef#

# GatewayGroupSummaryTypeDef definition

class GatewayGroupSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],

GatewayGroupTypeDef#

# GatewayGroupTypeDef definition

class GatewayGroupTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],

GatewaySummaryTypeDef#

# GatewaySummaryTypeDef definition

class GatewaySummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    GatewayGroupArn: NotRequired[str],
    SoftwareVersion: NotRequired[str],

GatewayTypeDef#

# GatewayTypeDef definition

class GatewayTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    GatewayGroupArn: NotRequired[str],
    SoftwareVersion: NotRequired[str],

GetAddressBookRequestRequestTypeDef#

# GetAddressBookRequestRequestTypeDef definition

class GetAddressBookRequestRequestTypeDef(TypedDict):
    AddressBookArn: str,

GetConferenceProviderRequestRequestTypeDef#

# GetConferenceProviderRequestRequestTypeDef definition

class GetConferenceProviderRequestRequestTypeDef(TypedDict):
    ConferenceProviderArn: str,

GetContactRequestRequestTypeDef#

# GetContactRequestRequestTypeDef definition

class GetContactRequestRequestTypeDef(TypedDict):
    ContactArn: str,

GetDeviceRequestRequestTypeDef#

# GetDeviceRequestRequestTypeDef definition

class GetDeviceRequestRequestTypeDef(TypedDict):
    DeviceArn: NotRequired[str],

GetGatewayGroupRequestRequestTypeDef#

# GetGatewayGroupRequestRequestTypeDef definition

class GetGatewayGroupRequestRequestTypeDef(TypedDict):
    GatewayGroupArn: str,

GetGatewayRequestRequestTypeDef#

# GetGatewayRequestRequestTypeDef definition

class GetGatewayRequestRequestTypeDef(TypedDict):
    GatewayArn: str,

GetNetworkProfileRequestRequestTypeDef#

# GetNetworkProfileRequestRequestTypeDef definition

class GetNetworkProfileRequestRequestTypeDef(TypedDict):
    NetworkProfileArn: str,

NetworkProfileTypeDef#

# NetworkProfileTypeDef definition

class NetworkProfileTypeDef(TypedDict):
    NetworkProfileArn: NotRequired[str],
    NetworkProfileName: NotRequired[str],
    Description: NotRequired[str],
    Ssid: NotRequired[str],
    SecurityType: NotRequired[NetworkSecurityTypeType],  # (1)
    EapMethod: NotRequired[NetworkEapMethodType],  # (2)
    CurrentPassword: NotRequired[str],
    NextPassword: NotRequired[str],
    CertificateAuthorityArn: NotRequired[str],
    TrustAnchors: NotRequired[List[str]],
  1. See NetworkSecurityTypeType
  2. See NetworkEapMethodType

GetProfileRequestRequestTypeDef#

# GetProfileRequestRequestTypeDef definition

class GetProfileRequestRequestTypeDef(TypedDict):
    ProfileArn: NotRequired[str],

GetRoomRequestRequestTypeDef#

# GetRoomRequestRequestTypeDef definition

class GetRoomRequestRequestTypeDef(TypedDict):
    RoomArn: NotRequired[str],

RoomTypeDef#

# RoomTypeDef definition

class RoomTypeDef(TypedDict):
    RoomArn: NotRequired[str],
    RoomName: NotRequired[str],
    Description: NotRequired[str],
    ProviderCalendarId: NotRequired[str],
    ProfileArn: NotRequired[str],

GetRoomSkillParameterRequestRequestTypeDef#

# GetRoomSkillParameterRequestRequestTypeDef definition

class GetRoomSkillParameterRequestRequestTypeDef(TypedDict):
    SkillId: str,
    ParameterKey: str,
    RoomArn: NotRequired[str],

RoomSkillParameterTypeDef#

# RoomSkillParameterTypeDef definition

class RoomSkillParameterTypeDef(TypedDict):
    ParameterKey: str,
    ParameterValue: str,

GetSkillGroupRequestRequestTypeDef#

# GetSkillGroupRequestRequestTypeDef definition

class GetSkillGroupRequestRequestTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],

SkillGroupTypeDef#

# SkillGroupTypeDef definition

class SkillGroupTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],
    SkillGroupName: NotRequired[str],
    Description: NotRequired[str],

InstantBookingTypeDef#

# InstantBookingTypeDef definition

class InstantBookingTypeDef(TypedDict):
    DurationInMinutes: NotRequired[int],
    Enabled: NotRequired[bool],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListBusinessReportSchedulesRequestRequestTypeDef#

# ListBusinessReportSchedulesRequestRequestTypeDef definition

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

ListConferenceProvidersRequestRequestTypeDef#

# ListConferenceProvidersRequestRequestTypeDef definition

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

ListDeviceEventsRequestRequestTypeDef#

# ListDeviceEventsRequestRequestTypeDef definition

class ListDeviceEventsRequestRequestTypeDef(TypedDict):
    DeviceArn: str,
    EventType: NotRequired[DeviceEventTypeType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See DeviceEventTypeType

ListGatewayGroupsRequestRequestTypeDef#

# ListGatewayGroupsRequestRequestTypeDef definition

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

ListGatewaysRequestRequestTypeDef#

# ListGatewaysRequestRequestTypeDef definition

class ListGatewaysRequestRequestTypeDef(TypedDict):
    GatewayGroupArn: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListSkillsRequestRequestTypeDef#

# ListSkillsRequestRequestTypeDef definition

class ListSkillsRequestRequestTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],
    EnablementType: NotRequired[EnablementTypeFilterType],  # (1)
    SkillType: NotRequired[SkillTypeFilterType],  # (2)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See EnablementTypeFilterType
  2. See SkillTypeFilterType

SkillSummaryTypeDef#

# SkillSummaryTypeDef definition

class SkillSummaryTypeDef(TypedDict):
    SkillId: NotRequired[str],
    SkillName: NotRequired[str],
    SupportsLinking: NotRequired[bool],
    EnablementType: NotRequired[EnablementTypeType],  # (1)
    SkillType: NotRequired[SkillTypeType],  # (2)
  1. See EnablementTypeType
  2. See SkillTypeType

ListSkillsStoreCategoriesRequestRequestTypeDef#

# ListSkillsStoreCategoriesRequestRequestTypeDef definition

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

ListSkillsStoreSkillsByCategoryRequestRequestTypeDef#

# ListSkillsStoreSkillsByCategoryRequestRequestTypeDef definition

class ListSkillsStoreSkillsByCategoryRequestRequestTypeDef(TypedDict):
    CategoryId: int,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListSmartHomeAppliancesRequestRequestTypeDef#

# ListSmartHomeAppliancesRequestRequestTypeDef definition

class ListSmartHomeAppliancesRequestRequestTypeDef(TypedDict):
    RoomArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

SmartHomeApplianceTypeDef#

# SmartHomeApplianceTypeDef definition

class SmartHomeApplianceTypeDef(TypedDict):
    FriendlyName: NotRequired[str],
    Description: NotRequired[str],
    ManufacturerName: NotRequired[str],

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef definition

class ListTagsRequestRequestTypeDef(TypedDict):
    Arn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ProactiveJoinTypeDef#

# ProactiveJoinTypeDef definition

class ProactiveJoinTypeDef(TypedDict):
    EnabledByMotion: NotRequired[bool],

RequireCheckInTypeDef#

# RequireCheckInTypeDef definition

class RequireCheckInTypeDef(TypedDict):
    ReleaseAfterMinutes: NotRequired[int],
    Enabled: NotRequired[bool],

NetworkProfileDataTypeDef#

# NetworkProfileDataTypeDef definition

class NetworkProfileDataTypeDef(TypedDict):
    NetworkProfileArn: NotRequired[str],
    NetworkProfileName: NotRequired[str],
    Description: NotRequired[str],
    Ssid: NotRequired[str],
    SecurityType: NotRequired[NetworkSecurityTypeType],  # (1)
    EapMethod: NotRequired[NetworkEapMethodType],  # (2)
    CertificateAuthorityArn: NotRequired[str],
  1. See NetworkSecurityTypeType
  2. See NetworkEapMethodType

ProfileDataTypeDef#

# ProfileDataTypeDef definition

class ProfileDataTypeDef(TypedDict):
    ProfileArn: NotRequired[str],
    ProfileName: NotRequired[str],
    IsDefault: NotRequired[bool],
    Address: NotRequired[str],
    Timezone: NotRequired[str],
    DistanceUnit: NotRequired[DistanceUnitType],  # (1)
    TemperatureUnit: NotRequired[TemperatureUnitType],  # (2)
    WakeWord: NotRequired[WakeWordType],  # (3)
    Locale: NotRequired[str],
  1. See DistanceUnitType
  2. See TemperatureUnitType
  3. See WakeWordType

PutInvitationConfigurationRequestRequestTypeDef#

# PutInvitationConfigurationRequestRequestTypeDef definition

class PutInvitationConfigurationRequestRequestTypeDef(TypedDict):
    OrganizationName: str,
    ContactEmail: NotRequired[str],
    PrivateSkillIds: NotRequired[Sequence[str]],

PutSkillAuthorizationRequestRequestTypeDef#

# PutSkillAuthorizationRequestRequestTypeDef definition

class PutSkillAuthorizationRequestRequestTypeDef(TypedDict):
    AuthorizationResult: Mapping[str, str],
    SkillId: str,
    RoomArn: NotRequired[str],

RejectSkillRequestRequestTypeDef#

# RejectSkillRequestRequestTypeDef definition

class RejectSkillRequestRequestTypeDef(TypedDict):
    SkillId: str,

ResolveRoomRequestRequestTypeDef#

# ResolveRoomRequestRequestTypeDef definition

class ResolveRoomRequestRequestTypeDef(TypedDict):
    UserId: str,
    SkillId: str,

RevokeInvitationRequestRequestTypeDef#

# RevokeInvitationRequestRequestTypeDef definition

class RevokeInvitationRequestRequestTypeDef(TypedDict):
    UserArn: NotRequired[str],
    EnrollmentId: NotRequired[str],

RoomDataTypeDef#

# RoomDataTypeDef definition

class RoomDataTypeDef(TypedDict):
    RoomArn: NotRequired[str],
    RoomName: NotRequired[str],
    Description: NotRequired[str],
    ProviderCalendarId: NotRequired[str],
    ProfileArn: NotRequired[str],
    ProfileName: NotRequired[str],

SortTypeDef#

# SortTypeDef definition

class SortTypeDef(TypedDict):
    Key: str,
    Value: SortValueType,  # (1)
  1. See SortValueType

SkillGroupDataTypeDef#

# SkillGroupDataTypeDef definition

class SkillGroupDataTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],
    SkillGroupName: NotRequired[str],
    Description: NotRequired[str],

UserDataTypeDef#

# UserDataTypeDef definition

class UserDataTypeDef(TypedDict):
    UserArn: NotRequired[str],
    FirstName: NotRequired[str],
    LastName: NotRequired[str],
    Email: NotRequired[str],
    EnrollmentStatus: NotRequired[EnrollmentStatusType],  # (1)
    EnrollmentId: NotRequired[str],
  1. See EnrollmentStatusType

SendInvitationRequestRequestTypeDef#

# SendInvitationRequestRequestTypeDef definition

class SendInvitationRequestRequestTypeDef(TypedDict):
    UserArn: NotRequired[str],

StartDeviceSyncRequestRequestTypeDef#

# StartDeviceSyncRequestRequestTypeDef definition

class StartDeviceSyncRequestRequestTypeDef(TypedDict):
    Features: Sequence[FeatureType],  # (1)
    RoomArn: NotRequired[str],
    DeviceArn: NotRequired[str],
  1. See FeatureType

StartSmartHomeApplianceDiscoveryRequestRequestTypeDef#

# StartSmartHomeApplianceDiscoveryRequestRequestTypeDef definition

class StartSmartHomeApplianceDiscoveryRequestRequestTypeDef(TypedDict):
    RoomArn: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateAddressBookRequestRequestTypeDef#

# UpdateAddressBookRequestRequestTypeDef definition

class UpdateAddressBookRequestRequestTypeDef(TypedDict):
    AddressBookArn: str,
    Name: NotRequired[str],
    Description: NotRequired[str],

UpdateDeviceRequestRequestTypeDef#

# UpdateDeviceRequestRequestTypeDef definition

class UpdateDeviceRequestRequestTypeDef(TypedDict):
    DeviceArn: NotRequired[str],
    DeviceName: NotRequired[str],

UpdateEndOfMeetingReminderTypeDef#

# UpdateEndOfMeetingReminderTypeDef definition

class UpdateEndOfMeetingReminderTypeDef(TypedDict):
    ReminderAtMinutes: NotRequired[Sequence[int]],
    ReminderType: NotRequired[EndOfMeetingReminderTypeType],  # (1)
    Enabled: NotRequired[bool],
  1. See EndOfMeetingReminderTypeType

UpdateGatewayGroupRequestRequestTypeDef#

# UpdateGatewayGroupRequestRequestTypeDef definition

class UpdateGatewayGroupRequestRequestTypeDef(TypedDict):
    GatewayGroupArn: str,
    Name: NotRequired[str],
    Description: NotRequired[str],

UpdateGatewayRequestRequestTypeDef#

# UpdateGatewayRequestRequestTypeDef definition

class UpdateGatewayRequestRequestTypeDef(TypedDict):
    GatewayArn: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    SoftwareVersion: NotRequired[str],

UpdateInstantBookingTypeDef#

# UpdateInstantBookingTypeDef definition

class UpdateInstantBookingTypeDef(TypedDict):
    DurationInMinutes: NotRequired[int],
    Enabled: NotRequired[bool],

UpdateProactiveJoinTypeDef#

# UpdateProactiveJoinTypeDef definition

class UpdateProactiveJoinTypeDef(TypedDict):
    EnabledByMotion: bool,

UpdateRequireCheckInTypeDef#

# UpdateRequireCheckInTypeDef definition

class UpdateRequireCheckInTypeDef(TypedDict):
    ReleaseAfterMinutes: NotRequired[int],
    Enabled: NotRequired[bool],

UpdateNetworkProfileRequestRequestTypeDef#

# UpdateNetworkProfileRequestRequestTypeDef definition

class UpdateNetworkProfileRequestRequestTypeDef(TypedDict):
    NetworkProfileArn: str,
    NetworkProfileName: NotRequired[str],
    Description: NotRequired[str],
    CurrentPassword: NotRequired[str],
    NextPassword: NotRequired[str],
    CertificateAuthorityArn: NotRequired[str],
    TrustAnchors: NotRequired[Sequence[str]],

UpdateRoomRequestRequestTypeDef#

# UpdateRoomRequestRequestTypeDef definition

class UpdateRoomRequestRequestTypeDef(TypedDict):
    RoomArn: NotRequired[str],
    RoomName: NotRequired[str],
    Description: NotRequired[str],
    ProviderCalendarId: NotRequired[str],
    ProfileArn: NotRequired[str],

UpdateSkillGroupRequestRequestTypeDef#

# UpdateSkillGroupRequestRequestTypeDef definition

class UpdateSkillGroupRequestRequestTypeDef(TypedDict):
    SkillGroupArn: NotRequired[str],
    SkillGroupName: NotRequired[str],
    Description: NotRequired[str],

UpdateBusinessReportScheduleRequestRequestTypeDef#

# UpdateBusinessReportScheduleRequestRequestTypeDef definition

class UpdateBusinessReportScheduleRequestRequestTypeDef(TypedDict):
    ScheduleArn: str,
    S3BucketName: NotRequired[str],
    S3KeyPrefix: NotRequired[str],
    Format: NotRequired[BusinessReportFormatType],  # (1)
    ScheduleName: NotRequired[str],
    Recurrence: NotRequired[BusinessReportRecurrenceTypeDef],  # (2)
  1. See BusinessReportFormatType
  2. See BusinessReportRecurrenceTypeDef

BusinessReportTypeDef#

# BusinessReportTypeDef definition

class BusinessReportTypeDef(TypedDict):
    Status: NotRequired[BusinessReportStatusType],  # (1)
    FailureCode: NotRequired[BusinessReportFailureCodeType],  # (2)
    S3Location: NotRequired[BusinessReportS3LocationTypeDef],  # (3)
    DeliveryTime: NotRequired[datetime],
    DownloadUrl: NotRequired[str],
  1. See BusinessReportStatusType
  2. See BusinessReportFailureCodeType
  3. See BusinessReportS3LocationTypeDef

PutConferencePreferenceRequestRequestTypeDef#

# PutConferencePreferenceRequestRequestTypeDef definition

class PutConferencePreferenceRequestRequestTypeDef(TypedDict):
    ConferencePreference: ConferencePreferenceTypeDef,  # (1)
  1. See ConferencePreferenceTypeDef

ConferenceProviderTypeDef#

# ConferenceProviderTypeDef definition

class ConferenceProviderTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[ConferenceProviderTypeType],  # (1)
    IPDialIn: NotRequired[IPDialInTypeDef],  # (2)
    PSTNDialIn: NotRequired[PSTNDialInTypeDef],  # (3)
    MeetingSetting: NotRequired[MeetingSettingTypeDef],  # (4)
  1. See ConferenceProviderTypeType
  2. See IPDialInTypeDef
  3. See PSTNDialInTypeDef
  4. See MeetingSettingTypeDef

UpdateConferenceProviderRequestRequestTypeDef#

# UpdateConferenceProviderRequestRequestTypeDef definition

class UpdateConferenceProviderRequestRequestTypeDef(TypedDict):
    ConferenceProviderArn: str,
    ConferenceProviderType: ConferenceProviderTypeType,  # (1)
    MeetingSetting: MeetingSettingTypeDef,  # (2)
    IPDialIn: NotRequired[IPDialInTypeDef],  # (3)
    PSTNDialIn: NotRequired[PSTNDialInTypeDef],  # (4)
  1. See ConferenceProviderTypeType
  2. See MeetingSettingTypeDef
  3. See IPDialInTypeDef
  4. See PSTNDialInTypeDef

ContactDataTypeDef#

# ContactDataTypeDef definition

class ContactDataTypeDef(TypedDict):
    ContactArn: NotRequired[str],
    DisplayName: NotRequired[str],
    FirstName: NotRequired[str],
    LastName: NotRequired[str],
    PhoneNumber: NotRequired[str],
    PhoneNumbers: NotRequired[List[PhoneNumberTypeDef]],  # (1)
    SipAddresses: NotRequired[List[SipAddressTypeDef]],  # (2)
  1. See PhoneNumberTypeDef
  2. See SipAddressTypeDef

ContactTypeDef#

# ContactTypeDef definition

class ContactTypeDef(TypedDict):
    ContactArn: NotRequired[str],
    DisplayName: NotRequired[str],
    FirstName: NotRequired[str],
    LastName: NotRequired[str],
    PhoneNumber: NotRequired[str],
    PhoneNumbers: NotRequired[List[PhoneNumberTypeDef]],  # (1)
    SipAddresses: NotRequired[List[SipAddressTypeDef]],  # (2)
  1. See PhoneNumberTypeDef
  2. See SipAddressTypeDef

UpdateContactRequestRequestTypeDef#

# UpdateContactRequestRequestTypeDef definition

class UpdateContactRequestRequestTypeDef(TypedDict):
    ContactArn: str,
    DisplayName: NotRequired[str],
    FirstName: NotRequired[str],
    LastName: NotRequired[str],
    PhoneNumber: NotRequired[str],
    PhoneNumbers: NotRequired[Sequence[PhoneNumberTypeDef]],  # (1)
    SipAddresses: NotRequired[Sequence[SipAddressTypeDef]],  # (2)
  1. See PhoneNumberTypeDef
  2. See SipAddressTypeDef

ContentTypeDef#

# ContentTypeDef definition

class ContentTypeDef(TypedDict):
    TextList: NotRequired[Sequence[TextTypeDef]],  # (1)
    SsmlList: NotRequired[Sequence[SsmlTypeDef]],  # (2)
    AudioList: NotRequired[Sequence[AudioTypeDef]],  # (3)
  1. See TextTypeDef
  2. See SsmlTypeDef
  3. See AudioTypeDef

CreateAddressBookRequestRequestTypeDef#

# CreateAddressBookRequestRequestTypeDef definition

class CreateAddressBookRequestRequestTypeDef(TypedDict):
    Name: str,
    Description: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateBusinessReportScheduleRequestRequestTypeDef#

# CreateBusinessReportScheduleRequestRequestTypeDef definition

class CreateBusinessReportScheduleRequestRequestTypeDef(TypedDict):
    Format: BusinessReportFormatType,  # (1)
    ContentRange: BusinessReportContentRangeTypeDef,  # (2)
    ScheduleName: NotRequired[str],
    S3BucketName: NotRequired[str],
    S3KeyPrefix: NotRequired[str],
    Recurrence: NotRequired[BusinessReportRecurrenceTypeDef],  # (3)
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See BusinessReportFormatType
  2. See BusinessReportContentRangeTypeDef
  3. See BusinessReportRecurrenceTypeDef
  4. See TagTypeDef

CreateConferenceProviderRequestRequestTypeDef#

# CreateConferenceProviderRequestRequestTypeDef definition

class CreateConferenceProviderRequestRequestTypeDef(TypedDict):
    ConferenceProviderName: str,
    ConferenceProviderType: ConferenceProviderTypeType,  # (1)
    MeetingSetting: MeetingSettingTypeDef,  # (2)
    IPDialIn: NotRequired[IPDialInTypeDef],  # (3)
    PSTNDialIn: NotRequired[PSTNDialInTypeDef],  # (4)
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
  1. See ConferenceProviderTypeType
  2. See MeetingSettingTypeDef
  3. See IPDialInTypeDef
  4. See PSTNDialInTypeDef
  5. See TagTypeDef

CreateContactRequestRequestTypeDef#

# CreateContactRequestRequestTypeDef definition

class CreateContactRequestRequestTypeDef(TypedDict):
    FirstName: str,
    DisplayName: NotRequired[str],
    LastName: NotRequired[str],
    PhoneNumber: NotRequired[str],
    PhoneNumbers: NotRequired[Sequence[PhoneNumberTypeDef]],  # (1)
    SipAddresses: NotRequired[Sequence[SipAddressTypeDef]],  # (2)
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See PhoneNumberTypeDef
  2. See SipAddressTypeDef
  3. See TagTypeDef

CreateGatewayGroupRequestRequestTypeDef#

# CreateGatewayGroupRequestRequestTypeDef definition

class CreateGatewayGroupRequestRequestTypeDef(TypedDict):
    Name: str,
    ClientRequestToken: str,
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateNetworkProfileRequestRequestTypeDef#

# CreateNetworkProfileRequestRequestTypeDef definition

class CreateNetworkProfileRequestRequestTypeDef(TypedDict):
    NetworkProfileName: str,
    Ssid: str,
    SecurityType: NetworkSecurityTypeType,  # (1)
    ClientRequestToken: str,
    Description: NotRequired[str],
    EapMethod: NotRequired[NetworkEapMethodType],  # (2)
    C