Skip to content

AlexaForBusinessClient

Index > AlexaForBusiness > AlexaForBusinessClient

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

AlexaForBusinessClient

Type annotations and code completion for boto3.client("alexaforbusiness"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_alexaforbusiness.client import AlexaForBusinessClient

def get_alexaforbusiness_client() -> AlexaForBusinessClient:
    return Session().client("alexaforbusiness")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("alexaforbusiness").exceptions structure.

Usage example
client = boto3.client("alexaforbusiness")

try:
    do_something(client)
except (
    client.AlreadyExistsException,
    client.ClientError,
    client.ConcurrentModificationException,
    client.DeviceNotRegisteredException,
    client.InvalidCertificateAuthorityException,
    client.InvalidDeviceException,
    client.InvalidSecretsManagerResourceException,
    client.InvalidServiceLinkedRoleStateException,
    client.InvalidUserStatusException,
    client.LimitExceededException,
    client.NameInUseException,
    client.NotFoundException,
    client.ResourceAssociatedException,
    client.ResourceInUseException,
    client.SkillNotLinkedException,
    client.UnauthorizedException,
) as e:
    print(e)
Type checking example
from mypy_boto3_alexaforbusiness.client import Exceptions

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

Methods

approve_skill

Associates a skill with the organization under the customer's AWS account.

Type annotations and code completion for boto3.client("alexaforbusiness").approve_skill method. boto3 documentation

Method definition
def approve_skill(
    self,
    *,
    SkillId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: ApproveSkillRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
}

parent.approve_skill(**kwargs)
  1. See ApproveSkillRequestRequestTypeDef

associate_contact_with_address_book

Associates a contact with a given address book.

Type annotations and code completion for boto3.client("alexaforbusiness").associate_contact_with_address_book method. boto3 documentation

Method definition
def associate_contact_with_address_book(
    self,
    *,
    ContactArn: str,
    AddressBookArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateContactWithAddressBookRequestRequestTypeDef = {  # (1)
    "ContactArn": ...,
    "AddressBookArn": ...,
}

parent.associate_contact_with_address_book(**kwargs)
  1. See AssociateContactWithAddressBookRequestRequestTypeDef

associate_device_with_network_profile

Associates a device with the specified network profile.

Type annotations and code completion for boto3.client("alexaforbusiness").associate_device_with_network_profile method. boto3 documentation

Method definition
def associate_device_with_network_profile(
    self,
    *,
    DeviceArn: str,
    NetworkProfileArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateDeviceWithNetworkProfileRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
    "NetworkProfileArn": ...,
}

parent.associate_device_with_network_profile(**kwargs)
  1. See AssociateDeviceWithNetworkProfileRequestRequestTypeDef

associate_device_with_room

Associates a device with a given room.

Type annotations and code completion for boto3.client("alexaforbusiness").associate_device_with_room method. boto3 documentation

Method definition
def associate_device_with_room(
    self,
    *,
    DeviceArn: str = ...,
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateDeviceWithRoomRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
}

parent.associate_device_with_room(**kwargs)
  1. See AssociateDeviceWithRoomRequestRequestTypeDef

associate_skill_group_with_room

Associates a skill group with a given room.

Type annotations and code completion for boto3.client("alexaforbusiness").associate_skill_group_with_room method. boto3 documentation

Method definition
def associate_skill_group_with_room(
    self,
    *,
    SkillGroupArn: str = ...,
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateSkillGroupWithRoomRequestRequestTypeDef = {  # (1)
    "SkillGroupArn": ...,
}

parent.associate_skill_group_with_room(**kwargs)
  1. See AssociateSkillGroupWithRoomRequestRequestTypeDef

associate_skill_with_skill_group

Associates a skill with a skill group.

Type annotations and code completion for boto3.client("alexaforbusiness").associate_skill_with_skill_group method. boto3 documentation

Method definition
def associate_skill_with_skill_group(
    self,
    *,
    SkillId: str,
    SkillGroupArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateSkillWithSkillGroupRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
}

parent.associate_skill_with_skill_group(**kwargs)
  1. See AssociateSkillWithSkillGroupRequestRequestTypeDef

associate_skill_with_users

Makes a private skill available for enrolled users to enable on their devices.

Type annotations and code completion for boto3.client("alexaforbusiness").associate_skill_with_users method. boto3 documentation

Method definition
def associate_skill_with_users(
    self,
    *,
    SkillId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateSkillWithUsersRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
}

parent.associate_skill_with_users(**kwargs)
  1. See AssociateSkillWithUsersRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("alexaforbusiness").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("alexaforbusiness").close method. boto3 documentation

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

create_address_book

Creates an address book with the specified details.

Type annotations and code completion for boto3.client("alexaforbusiness").create_address_book method. boto3 documentation

Method definition
def create_address_book(
    self,
    *,
    Name: str,
    Description: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAddressBookResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateAddressBookResponseTypeDef
Usage example with kwargs
kwargs: CreateAddressBookRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_address_book(**kwargs)
  1. See CreateAddressBookRequestRequestTypeDef

create_business_report_schedule

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Type annotations and code completion for boto3.client("alexaforbusiness").create_business_report_schedule method. boto3 documentation

Method definition
def create_business_report_schedule(
    self,
    *,
    Format: BusinessReportFormatType,  # (1)
    ContentRange: BusinessReportContentRangeTypeDef,  # (2)
    ScheduleName: str = ...,
    S3BucketName: str = ...,
    S3KeyPrefix: str = ...,
    Recurrence: BusinessReportRecurrenceTypeDef = ...,  # (3)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateBusinessReportScheduleResponseTypeDef:  # (5)
    ...
  1. See BusinessReportFormatType
  2. See BusinessReportContentRangeTypeDef
  3. See BusinessReportRecurrenceTypeDef
  4. See TagTypeDef
  5. See CreateBusinessReportScheduleResponseTypeDef
Usage example with kwargs
kwargs: CreateBusinessReportScheduleRequestRequestTypeDef = {  # (1)
    "Format": ...,
    "ContentRange": ...,
}

parent.create_business_report_schedule(**kwargs)
  1. See CreateBusinessReportScheduleRequestRequestTypeDef

create_conference_provider

Adds a new conference provider under the user's AWS account.

Type annotations and code completion for boto3.client("alexaforbusiness").create_conference_provider method. boto3 documentation

Method definition
def create_conference_provider(
    self,
    *,
    ConferenceProviderName: str,
    ConferenceProviderType: ConferenceProviderTypeType,  # (1)
    MeetingSetting: MeetingSettingTypeDef,  # (2)
    IPDialIn: IPDialInTypeDef = ...,  # (3)
    PSTNDialIn: PSTNDialInTypeDef = ...,  # (4)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateConferenceProviderResponseTypeDef:  # (6)
    ...
  1. See ConferenceProviderTypeType
  2. See MeetingSettingTypeDef
  3. See IPDialInTypeDef
  4. See PSTNDialInTypeDef
  5. See TagTypeDef
  6. See CreateConferenceProviderResponseTypeDef
Usage example with kwargs
kwargs: CreateConferenceProviderRequestRequestTypeDef = {  # (1)
    "ConferenceProviderName": ...,
    "ConferenceProviderType": ...,
    "MeetingSetting": ...,
}

parent.create_conference_provider(**kwargs)
  1. See CreateConferenceProviderRequestRequestTypeDef

create_contact

Creates a contact with the specified details.

Type annotations and code completion for boto3.client("alexaforbusiness").create_contact method. boto3 documentation

Method definition
def create_contact(
    self,
    *,
    FirstName: str,
    DisplayName: str = ...,
    LastName: str = ...,
    PhoneNumber: str = ...,
    PhoneNumbers: Sequence[PhoneNumberTypeDef] = ...,  # (1)
    SipAddresses: Sequence[SipAddressTypeDef] = ...,  # (2)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateContactResponseTypeDef:  # (4)
    ...
  1. See PhoneNumberTypeDef
  2. See SipAddressTypeDef
  3. See TagTypeDef
  4. See CreateContactResponseTypeDef
Usage example with kwargs
kwargs: CreateContactRequestRequestTypeDef = {  # (1)
    "FirstName": ...,
}

parent.create_contact(**kwargs)
  1. See CreateContactRequestRequestTypeDef

create_gateway_group

Creates a gateway group with the specified details.

Type annotations and code completion for boto3.client("alexaforbusiness").create_gateway_group method. boto3 documentation

Method definition
def create_gateway_group(
    self,
    *,
    Name: str,
    ClientRequestToken: str,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateGatewayGroupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateGatewayGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateGatewayGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ClientRequestToken": ...,
}

parent.create_gateway_group(**kwargs)
  1. See CreateGatewayGroupRequestRequestTypeDef

create_network_profile

Creates a network profile with the specified details.

Type annotations and code completion for boto3.client("alexaforbusiness").create_network_profile method. boto3 documentation

Method definition
def create_network_profile(
    self,
    *,
    NetworkProfileName: str,
    Ssid: str,
    SecurityType: NetworkSecurityTypeType,  # (1)
    ClientRequestToken: str,
    Description: str = ...,
    EapMethod: NetworkEapMethodType = ...,  # (2)
    CurrentPassword: str = ...,
    NextPassword: str = ...,
    CertificateAuthorityArn: str = ...,
    TrustAnchors: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateNetworkProfileResponseTypeDef:  # (4)
    ...
  1. See NetworkSecurityTypeType
  2. See NetworkEapMethodType
  3. See TagTypeDef
  4. See CreateNetworkProfileResponseTypeDef
Usage example with kwargs
kwargs: CreateNetworkProfileRequestRequestTypeDef = {  # (1)
    "NetworkProfileName": ...,
    "Ssid": ...,
    "SecurityType": ...,
    "ClientRequestToken": ...,
}

parent.create_network_profile(**kwargs)
  1. See CreateNetworkProfileRequestRequestTypeDef

create_profile

Creates a new room profile with the specified details.

Type annotations and code completion for boto3.client("alexaforbusiness").create_profile method. boto3 documentation

Method definition
def create_profile(
    self,
    *,
    ProfileName: str,
    Timezone: str,
    Address: str,
    DistanceUnit: DistanceUnitType,  # (1)
    TemperatureUnit: TemperatureUnitType,  # (2)
    WakeWord: WakeWordType,  # (3)
    Locale: str = ...,
    ClientRequestToken: str = ...,
    SetupModeDisabled: bool = ...,
    MaxVolumeLimit: int = ...,
    PSTNEnabled: bool = ...,
    DataRetentionOptIn: bool = ...,
    MeetingRoomConfiguration: CreateMeetingRoomConfigurationTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateProfileResponseTypeDef:  # (6)
    ...
  1. See DistanceUnitType
  2. See TemperatureUnitType
  3. See WakeWordType
  4. See CreateMeetingRoomConfigurationTypeDef
  5. See TagTypeDef
  6. See CreateProfileResponseTypeDef
Usage example with kwargs
kwargs: CreateProfileRequestRequestTypeDef = {  # (1)
    "ProfileName": ...,
    "Timezone": ...,
    "Address": ...,
    "DistanceUnit": ...,
    "TemperatureUnit": ...,
    "WakeWord": ...,
}

parent.create_profile(**kwargs)
  1. See CreateProfileRequestRequestTypeDef

create_room

Creates a room with the specified details.

Type annotations and code completion for boto3.client("alexaforbusiness").create_room method. boto3 documentation

Method definition
def create_room(
    self,
    *,
    RoomName: str,
    Description: str = ...,
    ProfileArn: str = ...,
    ProviderCalendarId: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRoomResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateRoomResponseTypeDef
Usage example with kwargs
kwargs: CreateRoomRequestRequestTypeDef = {  # (1)
    "RoomName": ...,
}

parent.create_room(**kwargs)
  1. See CreateRoomRequestRequestTypeDef

create_skill_group

Creates a skill group with a specified name and description.

Type annotations and code completion for boto3.client("alexaforbusiness").create_skill_group method. boto3 documentation

Method definition
def create_skill_group(
    self,
    *,
    SkillGroupName: str,
    Description: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSkillGroupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateSkillGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateSkillGroupRequestRequestTypeDef = {  # (1)
    "SkillGroupName": ...,
}

parent.create_skill_group(**kwargs)
  1. See CreateSkillGroupRequestRequestTypeDef

create_user

Creates a user.

Type annotations and code completion for boto3.client("alexaforbusiness").create_user method. boto3 documentation

Method definition
def create_user(
    self,
    *,
    UserId: str,
    FirstName: str = ...,
    LastName: str = ...,
    Email: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateUserResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateUserResponseTypeDef
Usage example with kwargs
kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "UserId": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestRequestTypeDef

delete_address_book

Deletes an address book by the address book ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_address_book method. boto3 documentation

Method definition
def delete_address_book(
    self,
    *,
    AddressBookArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAddressBookRequestRequestTypeDef = {  # (1)
    "AddressBookArn": ...,
}

parent.delete_address_book(**kwargs)
  1. See DeleteAddressBookRequestRequestTypeDef

delete_business_report_schedule

Deletes the recurring report delivery schedule with the specified schedule ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_business_report_schedule method. boto3 documentation

Method definition
def delete_business_report_schedule(
    self,
    *,
    ScheduleArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteBusinessReportScheduleRequestRequestTypeDef = {  # (1)
    "ScheduleArn": ...,
}

parent.delete_business_report_schedule(**kwargs)
  1. See DeleteBusinessReportScheduleRequestRequestTypeDef

delete_conference_provider

Deletes a conference provider.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_conference_provider method. boto3 documentation

Method definition
def delete_conference_provider(
    self,
    *,
    ConferenceProviderArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteConferenceProviderRequestRequestTypeDef = {  # (1)
    "ConferenceProviderArn": ...,
}

parent.delete_conference_provider(**kwargs)
  1. See DeleteConferenceProviderRequestRequestTypeDef

delete_contact

Deletes a contact by the contact ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_contact method. boto3 documentation

Method definition
def delete_contact(
    self,
    *,
    ContactArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteContactRequestRequestTypeDef = {  # (1)
    "ContactArn": ...,
}

parent.delete_contact(**kwargs)
  1. See DeleteContactRequestRequestTypeDef

delete_device

Removes a device from Alexa For Business.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_device method. boto3 documentation

Method definition
def delete_device(
    self,
    *,
    DeviceArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDeviceRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
}

parent.delete_device(**kwargs)
  1. See DeleteDeviceRequestRequestTypeDef

delete_device_usage_data

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_device_usage_data method. boto3 documentation

Method definition
def delete_device_usage_data(
    self,
    *,
    DeviceArn: str,
    DeviceUsageType: DeviceUsageTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DeviceUsageTypeType
Usage example with kwargs
kwargs: DeleteDeviceUsageDataRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
    "DeviceUsageType": ...,
}

parent.delete_device_usage_data(**kwargs)
  1. See DeleteDeviceUsageDataRequestRequestTypeDef

delete_gateway_group

Deletes a gateway group.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_gateway_group method. boto3 documentation

Method definition
def delete_gateway_group(
    self,
    *,
    GatewayGroupArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteGatewayGroupRequestRequestTypeDef = {  # (1)
    "GatewayGroupArn": ...,
}

parent.delete_gateway_group(**kwargs)
  1. See DeleteGatewayGroupRequestRequestTypeDef

delete_network_profile

Deletes a network profile by the network profile ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_network_profile method. boto3 documentation

Method definition
def delete_network_profile(
    self,
    *,
    NetworkProfileArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteNetworkProfileRequestRequestTypeDef = {  # (1)
    "NetworkProfileArn": ...,
}

parent.delete_network_profile(**kwargs)
  1. See DeleteNetworkProfileRequestRequestTypeDef

delete_profile

Deletes a room profile by the profile ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_profile method. boto3 documentation

Method definition
def delete_profile(
    self,
    *,
    ProfileArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteProfileRequestRequestTypeDef = {  # (1)
    "ProfileArn": ...,
}

parent.delete_profile(**kwargs)
  1. See DeleteProfileRequestRequestTypeDef

delete_room

Deletes a room by the room ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_room method. boto3 documentation

Method definition
def delete_room(
    self,
    *,
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteRoomRequestRequestTypeDef = {  # (1)
    "RoomArn": ...,
}

parent.delete_room(**kwargs)
  1. See DeleteRoomRequestRequestTypeDef

delete_room_skill_parameter

Deletes room skill parameter details by room, skill, and parameter key ID.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_room_skill_parameter method. boto3 documentation

Method definition
def delete_room_skill_parameter(
    self,
    *,
    SkillId: str,
    ParameterKey: str,
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteRoomSkillParameterRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
    "ParameterKey": ...,
}

parent.delete_room_skill_parameter(**kwargs)
  1. See DeleteRoomSkillParameterRequestRequestTypeDef

delete_skill_authorization

Unlinks a third-party account from a skill.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_skill_authorization method. boto3 documentation

Method definition
def delete_skill_authorization(
    self,
    *,
    SkillId: str,
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteSkillAuthorizationRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
}

parent.delete_skill_authorization(**kwargs)
  1. See DeleteSkillAuthorizationRequestRequestTypeDef

delete_skill_group

Deletes a skill group by skill group ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_skill_group method. boto3 documentation

Method definition
def delete_skill_group(
    self,
    *,
    SkillGroupArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteSkillGroupRequestRequestTypeDef = {  # (1)
    "SkillGroupArn": ...,
}

parent.delete_skill_group(**kwargs)
  1. See DeleteSkillGroupRequestRequestTypeDef

delete_user

Deletes a specified user by user ARN and enrollment ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").delete_user method. boto3 documentation

Method definition
def delete_user(
    self,
    *,
    EnrollmentId: str,
    UserArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "EnrollmentId": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestRequestTypeDef

disassociate_contact_from_address_book

Disassociates a contact from a given address book.

Type annotations and code completion for boto3.client("alexaforbusiness").disassociate_contact_from_address_book method. boto3 documentation

Method definition
def disassociate_contact_from_address_book(
    self,
    *,
    ContactArn: str,
    AddressBookArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateContactFromAddressBookRequestRequestTypeDef = {  # (1)
    "ContactArn": ...,
    "AddressBookArn": ...,
}

parent.disassociate_contact_from_address_book(**kwargs)
  1. See DisassociateContactFromAddressBookRequestRequestTypeDef

disassociate_device_from_room

Disassociates a device from its current room.

Type annotations and code completion for boto3.client("alexaforbusiness").disassociate_device_from_room method. boto3 documentation

Method definition
def disassociate_device_from_room(
    self,
    *,
    DeviceArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateDeviceFromRoomRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
}

parent.disassociate_device_from_room(**kwargs)
  1. See DisassociateDeviceFromRoomRequestRequestTypeDef

disassociate_skill_from_skill_group

Disassociates a skill from a skill group.

Type annotations and code completion for boto3.client("alexaforbusiness").disassociate_skill_from_skill_group method. boto3 documentation

Method definition
def disassociate_skill_from_skill_group(
    self,
    *,
    SkillId: str,
    SkillGroupArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateSkillFromSkillGroupRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
}

parent.disassociate_skill_from_skill_group(**kwargs)
  1. See DisassociateSkillFromSkillGroupRequestRequestTypeDef

disassociate_skill_from_users

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

Type annotations and code completion for boto3.client("alexaforbusiness").disassociate_skill_from_users method. boto3 documentation

Method definition
def disassociate_skill_from_users(
    self,
    *,
    SkillId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateSkillFromUsersRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
}

parent.disassociate_skill_from_users(**kwargs)
  1. See DisassociateSkillFromUsersRequestRequestTypeDef

disassociate_skill_group_from_room

Disassociates a skill group from a specified room.

Type annotations and code completion for boto3.client("alexaforbusiness").disassociate_skill_group_from_room method. boto3 documentation

Method definition
def disassociate_skill_group_from_room(
    self,
    *,
    SkillGroupArn: str = ...,
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateSkillGroupFromRoomRequestRequestTypeDef = {  # (1)
    "SkillGroupArn": ...,
}

parent.disassociate_skill_group_from_room(**kwargs)
  1. See DisassociateSkillGroupFromRoomRequestRequestTypeDef

forget_smart_home_appliances

Forgets smart home appliances associated to a room.

Type annotations and code completion for boto3.client("alexaforbusiness").forget_smart_home_appliances method. boto3 documentation

Method definition
def forget_smart_home_appliances(
    self,
    *,
    RoomArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: ForgetSmartHomeAppliancesRequestRequestTypeDef = {  # (1)
    "RoomArn": ...,
}

parent.forget_smart_home_appliances(**kwargs)
  1. See ForgetSmartHomeAppliancesRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("alexaforbusiness").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_address_book

Gets address the book details by the address book ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_address_book method. boto3 documentation

Method definition
def get_address_book(
    self,
    *,
    AddressBookArn: str,
) -> GetAddressBookResponseTypeDef:  # (1)
    ...
  1. See GetAddressBookResponseTypeDef
Usage example with kwargs
kwargs: GetAddressBookRequestRequestTypeDef = {  # (1)
    "AddressBookArn": ...,
}

parent.get_address_book(**kwargs)
  1. See GetAddressBookRequestRequestTypeDef

get_conference_preference

Retrieves the existing conference preferences.

Type annotations and code completion for boto3.client("alexaforbusiness").get_conference_preference method. boto3 documentation

Method definition
def get_conference_preference(
    self,
) -> GetConferencePreferenceResponseTypeDef:  # (1)
    ...
  1. See GetConferencePreferenceResponseTypeDef

get_conference_provider

Gets details about a specific conference provider.

Type annotations and code completion for boto3.client("alexaforbusiness").get_conference_provider method. boto3 documentation

Method definition
def get_conference_provider(
    self,
    *,
    ConferenceProviderArn: str,
) -> GetConferenceProviderResponseTypeDef:  # (1)
    ...
  1. See GetConferenceProviderResponseTypeDef
Usage example with kwargs
kwargs: GetConferenceProviderRequestRequestTypeDef = {  # (1)
    "ConferenceProviderArn": ...,
}

parent.get_conference_provider(**kwargs)
  1. See GetConferenceProviderRequestRequestTypeDef

get_contact

Gets the contact details by the contact ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_contact method. boto3 documentation

Method definition
def get_contact(
    self,
    *,
    ContactArn: str,
) -> GetContactResponseTypeDef:  # (1)
    ...
  1. See GetContactResponseTypeDef
Usage example with kwargs
kwargs: GetContactRequestRequestTypeDef = {  # (1)
    "ContactArn": ...,
}

parent.get_contact(**kwargs)
  1. See GetContactRequestRequestTypeDef

get_device

Gets the details of a device by device ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_device method. boto3 documentation

Method definition
def get_device(
    self,
    *,
    DeviceArn: str = ...,
) -> GetDeviceResponseTypeDef:  # (1)
    ...
  1. See GetDeviceResponseTypeDef
Usage example with kwargs
kwargs: GetDeviceRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
}

parent.get_device(**kwargs)
  1. See GetDeviceRequestRequestTypeDef

get_gateway

Retrieves the details of a gateway.

Type annotations and code completion for boto3.client("alexaforbusiness").get_gateway method. boto3 documentation

Method definition
def get_gateway(
    self,
    *,
    GatewayArn: str,
) -> GetGatewayResponseTypeDef:  # (1)
    ...
  1. See GetGatewayResponseTypeDef
Usage example with kwargs
kwargs: GetGatewayRequestRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.get_gateway(**kwargs)
  1. See GetGatewayRequestRequestTypeDef

get_gateway_group

Retrieves the details of a gateway group.

Type annotations and code completion for boto3.client("alexaforbusiness").get_gateway_group method. boto3 documentation

Method definition
def get_gateway_group(
    self,
    *,
    GatewayGroupArn: str,
) -> GetGatewayGroupResponseTypeDef:  # (1)
    ...
  1. See GetGatewayGroupResponseTypeDef
Usage example with kwargs
kwargs: GetGatewayGroupRequestRequestTypeDef = {  # (1)
    "GatewayGroupArn": ...,
}

parent.get_gateway_group(**kwargs)
  1. See GetGatewayGroupRequestRequestTypeDef

get_invitation_configuration

Retrieves the configured values for the user enrollment invitation email template.

Type annotations and code completion for boto3.client("alexaforbusiness").get_invitation_configuration method. boto3 documentation

Method definition
def get_invitation_configuration(
    self,
) -> GetInvitationConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetInvitationConfigurationResponseTypeDef

get_network_profile

Gets the network profile details by the network profile ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_network_profile method. boto3 documentation

Method definition
def get_network_profile(
    self,
    *,
    NetworkProfileArn: str,
) -> GetNetworkProfileResponseTypeDef:  # (1)
    ...
  1. See GetNetworkProfileResponseTypeDef
Usage example with kwargs
kwargs: GetNetworkProfileRequestRequestTypeDef = {  # (1)
    "NetworkProfileArn": ...,
}

parent.get_network_profile(**kwargs)
  1. See GetNetworkProfileRequestRequestTypeDef

get_profile

Gets the details of a room profile by profile ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_profile method. boto3 documentation

Method definition
def get_profile(
    self,
    *,
    ProfileArn: str = ...,
) -> GetProfileResponseTypeDef:  # (1)
    ...
  1. See GetProfileResponseTypeDef
Usage example with kwargs
kwargs: GetProfileRequestRequestTypeDef = {  # (1)
    "ProfileArn": ...,
}

parent.get_profile(**kwargs)
  1. See GetProfileRequestRequestTypeDef

get_room

Gets room details by room ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_room method. boto3 documentation

Method definition
def get_room(
    self,
    *,
    RoomArn: str = ...,
) -> GetRoomResponseTypeDef:  # (1)
    ...
  1. See GetRoomResponseTypeDef
Usage example with kwargs
kwargs: GetRoomRequestRequestTypeDef = {  # (1)
    "RoomArn": ...,
}

parent.get_room(**kwargs)
  1. See GetRoomRequestRequestTypeDef

get_room_skill_parameter

Gets room skill parameter details by room, skill, and parameter key ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_room_skill_parameter method. boto3 documentation

Method definition
def get_room_skill_parameter(
    self,
    *,
    SkillId: str,
    ParameterKey: str,
    RoomArn: str = ...,
) -> GetRoomSkillParameterResponseTypeDef:  # (1)
    ...
  1. See GetRoomSkillParameterResponseTypeDef
Usage example with kwargs
kwargs: GetRoomSkillParameterRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
    "ParameterKey": ...,
}

parent.get_room_skill_parameter(**kwargs)
  1. See GetRoomSkillParameterRequestRequestTypeDef

get_skill_group

Gets skill group details by skill group ARN.

Type annotations and code completion for boto3.client("alexaforbusiness").get_skill_group method. boto3 documentation

Method definition
def get_skill_group(
    self,
    *,
    SkillGroupArn: str = ...,
) -> GetSkillGroupResponseTypeDef:  # (1)
    ...
  1. See GetSkillGroupResponseTypeDef
Usage example with kwargs
kwargs: GetSkillGroupRequestRequestTypeDef = {  # (1)
    "SkillGroupArn": ...,
}

parent.get_skill_group(**kwargs)
  1. See GetSkillGroupRequestRequestTypeDef

list_business_report_schedules

Lists the details of the schedules that a user configured.

Type annotations and code completion for boto3.client("alexaforbusiness").list_business_report_schedules method. boto3 documentation

Method definition
def list_business_report_schedules(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBusinessReportSchedulesResponseTypeDef:  # (1)
    ...
  1. See ListBusinessReportSchedulesResponseTypeDef
Usage example with kwargs
kwargs: ListBusinessReportSchedulesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_business_report_schedules(**kwargs)
  1. See ListBusinessReportSchedulesRequestRequestTypeDef

list_conference_providers

Lists conference providers under a specific AWS account.

Type annotations and code completion for boto3.client("alexaforbusiness").list_conference_providers method. boto3 documentation

Method definition
def list_conference_providers(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListConferenceProvidersResponseTypeDef:  # (1)
    ...
  1. See ListConferenceProvidersResponseTypeDef
Usage example with kwargs
kwargs: ListConferenceProvidersRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_conference_providers(**kwargs)
  1. See ListConferenceProvidersRequestRequestTypeDef

list_device_events

Lists the device event history, including device connection status, for up to 30 days.

Type annota