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

Method definition

def list_device_events(
    self,
    *,
    DeviceArn: str,
    EventType: DeviceEventTypeType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDeviceEventsResponseTypeDef:  # (2)
    ...

1. See DeviceEventTypeType
2. See ListDeviceEventsResponseTypeDef

Usage example with kwargs

kwargs: ListDeviceEventsRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
}

parent.list_device_events(**kwargs)

1. See ListDeviceEventsRequestRequestTypeDef

list_gateway_groups

Retrieves a list of gateway group summaries.

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

Method definition

def list_gateway_groups(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGatewayGroupsResponseTypeDef:  # (1)
    ...

1. See ListGatewayGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListGatewayGroupsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_gateway_groups(**kwargs)

1. See ListGatewayGroupsRequestRequestTypeDef

list_gateways

Retrieves a list of gateway summaries.

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

Method definition

def list_gateways(
    self,
    *,
    GatewayGroupArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGatewaysResponseTypeDef:  # (1)
    ...

1. See ListGatewaysResponseTypeDef

Usage example with kwargs

kwargs: ListGatewaysRequestRequestTypeDef = {  # (1)
    "GatewayGroupArn": ...,
}

parent.list_gateways(**kwargs)

1. See ListGatewaysRequestRequestTypeDef

list_skills

Lists all enabled skills in a specific skill group.

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

Method definition

def list_skills(
    self,
    *,
    SkillGroupArn: str = ...,
    EnablementType: EnablementTypeFilterType = ...,  # (1)
    SkillType: SkillTypeFilterType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSkillsResponseTypeDef:  # (3)
    ...

1. See EnablementTypeFilterType
2. See SkillTypeFilterType
3. See ListSkillsResponseTypeDef

Usage example with kwargs

kwargs: ListSkillsRequestRequestTypeDef = {  # (1)
    "SkillGroupArn": ...,
}

parent.list_skills(**kwargs)

1. See ListSkillsRequestRequestTypeDef

list_skills_store_categories

Lists all categories in the Alexa skill store.

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

Method definition

def list_skills_store_categories(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSkillsStoreCategoriesResponseTypeDef:  # (1)
    ...

1. See ListSkillsStoreCategoriesResponseTypeDef

Usage example with kwargs

kwargs: ListSkillsStoreCategoriesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_skills_store_categories(**kwargs)

1. See ListSkillsStoreCategoriesRequestRequestTypeDef

list_skills_store_skills_by_category

Lists all skills in the Alexa skill store by category.

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

Method definition

def list_skills_store_skills_by_category(
    self,
    *,
    CategoryId: int,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSkillsStoreSkillsByCategoryResponseTypeDef:  # (1)
    ...

1. See ListSkillsStoreSkillsByCategoryResponseTypeDef

Usage example with kwargs

kwargs: ListSkillsStoreSkillsByCategoryRequestRequestTypeDef = {  # (1)
    "CategoryId": ...,
}

parent.list_skills_store_skills_by_category(**kwargs)

1. See ListSkillsStoreSkillsByCategoryRequestRequestTypeDef

list_smart_home_appliances

Lists all of the smart home appliances associated with a room.

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

Method definition

def list_smart_home_appliances(
    self,
    *,
    RoomArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSmartHomeAppliancesResponseTypeDef:  # (1)
    ...

1. See ListSmartHomeAppliancesResponseTypeDef

Usage example with kwargs

kwargs: ListSmartHomeAppliancesRequestRequestTypeDef = {  # (1)
    "RoomArn": ...,
}

parent.list_smart_home_appliances(**kwargs)

1. See ListSmartHomeAppliancesRequestRequestTypeDef

list_tags

Lists all tags for the specified resource.

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

Method definition

def list_tags(
    self,
    *,
    Arn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsResponseTypeDef:  # (1)
    ...

1. See ListTagsResponseTypeDef

Usage example with kwargs

kwargs: ListTagsRequestRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.list_tags(**kwargs)

1. See ListTagsRequestRequestTypeDef

put_conference_preference

Sets the conference preferences on a specific conference provider at the account level.

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

Method definition

def put_conference_preference(
    self,
    *,
    ConferencePreference: ConferencePreferenceTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See ConferencePreferenceTypeDef

Usage example with kwargs

kwargs: PutConferencePreferenceRequestRequestTypeDef = {  # (1)
    "ConferencePreference": ...,
}

parent.put_conference_preference(**kwargs)

1. See PutConferencePreferenceRequestRequestTypeDef

put_invitation_configuration

Configures the email template for the user enrollment invitation with the specified attributes.

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

Method definition

def put_invitation_configuration(
    self,
    *,
    OrganizationName: str,
    ContactEmail: str = ...,
    PrivateSkillIds: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: PutInvitationConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationName": ...,
}

parent.put_invitation_configuration(**kwargs)

1. See PutInvitationConfigurationRequestRequestTypeDef

put_room_skill_parameter

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

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

Method definition

def put_room_skill_parameter(
    self,
    *,
    SkillId: str,
    RoomSkillParameter: RoomSkillParameterTypeDef,  # (1)
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...

1. See RoomSkillParameterTypeDef

Usage example with kwargs

kwargs: PutRoomSkillParameterRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
    "RoomSkillParameter": ...,
}

parent.put_room_skill_parameter(**kwargs)

1. See PutRoomSkillParameterRequestRequestTypeDef

put_skill_authorization

Links a user's account to a third-party skill provider.

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

Method definition

def put_skill_authorization(
    self,
    *,
    AuthorizationResult: Mapping[str, str],
    SkillId: str,
    RoomArn: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: PutSkillAuthorizationRequestRequestTypeDef = {  # (1)
    "AuthorizationResult": ...,
    "SkillId": ...,
}

parent.put_skill_authorization(**kwargs)

1. See PutSkillAuthorizationRequestRequestTypeDef

register_avs_device

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

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

Method definition

def register_avs_device(
    self,
    *,
    ClientId: str,
    UserCode: str,
    ProductId: str,
    AmazonId: str,
    DeviceSerialNumber: str = ...,
    RoomArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> RegisterAVSDeviceResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See RegisterAVSDeviceResponseTypeDef

Usage example with kwargs

kwargs: RegisterAVSDeviceRequestRequestTypeDef = {  # (1)
    "ClientId": ...,
    "UserCode": ...,
    "ProductId": ...,
    "AmazonId": ...,
}

parent.register_avs_device(**kwargs)

1. See RegisterAVSDeviceRequestRequestTypeDef

reject_skill

Disassociates a skill from the organization under a user's AWS account.

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

Method definition

def reject_skill(
    self,
    *,
    SkillId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RejectSkillRequestRequestTypeDef = {  # (1)
    "SkillId": ...,
}

parent.reject_skill(**kwargs)

1. See RejectSkillRequestRequestTypeDef

resolve_room

Determines the details for the room from which a skill request was invoked.

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

Method definition

def resolve_room(
    self,
    *,
    UserId: str,
    SkillId: str,
) -> ResolveRoomResponseTypeDef:  # (1)
    ...

1. See ResolveRoomResponseTypeDef

Usage example with kwargs

kwargs: ResolveRoomRequestRequestTypeDef = {  # (1)
    "UserId": ...,
    "SkillId": ...,
}

parent.resolve_room(**kwargs)

1. See ResolveRoomRequestRequestTypeDef

revoke_invitation

Revokes an invitation and invalidates the enrollment URL.

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

Method definition

def revoke_invitation(
    self,
    *,
    UserArn: str = ...,
    EnrollmentId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RevokeInvitationRequestRequestTypeDef = {  # (1)
    "UserArn": ...,
}

parent.revoke_invitation(**kwargs)

1. See RevokeInvitationRequestRequestTypeDef

search_address_books

Searches address books and lists the ones that meet a set of filter and sort criteria.

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

Method definition

def search_address_books(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> SearchAddressBooksResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchAddressBooksResponseTypeDef

Usage example with kwargs

kwargs: SearchAddressBooksRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.search_address_books(**kwargs)

1. See SearchAddressBooksRequestRequestTypeDef

search_contacts

Searches contacts and lists the ones that meet a set of filter and sort criteria.

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

Method definition

def search_contacts(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> SearchContactsResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchContactsResponseTypeDef

Usage example with kwargs

kwargs: SearchContactsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.search_contacts(**kwargs)

1. See SearchContactsRequestRequestTypeDef

search_devices

Searches devices and lists the ones that meet a set of filter criteria.

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

Method definition

def search_devices(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
) -> SearchDevicesResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchDevicesResponseTypeDef

Usage example with kwargs

kwargs: SearchDevicesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.search_devices(**kwargs)

1. See SearchDevicesRequestRequestTypeDef

search_network_profiles

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

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

Method definition

def search_network_profiles(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
) -> SearchNetworkProfilesResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchNetworkProfilesResponseTypeDef

Usage example with kwargs

kwargs: SearchNetworkProfilesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.search_network_profiles(**kwargs)

1. See SearchNetworkProfilesRequestRequestTypeDef

search_profiles

Searches room profiles and lists the ones that meet a set of filter criteria.

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

Method definition

def search_profiles(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
) -> SearchProfilesResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchProfilesResponseTypeDef

Usage example with kwargs

kwargs: SearchProfilesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.search_profiles(**kwargs)

1. See SearchProfilesRequestRequestTypeDef

search_rooms

Searches rooms and lists the ones that meet a set of filter and sort criteria.

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

Method definition

def search_rooms(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
) -> SearchRoomsResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchRoomsResponseTypeDef

Usage example with kwargs

kwargs: SearchRoomsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.search_rooms(**kwargs)

1. See SearchRoomsRequestRequestTypeDef

search_skill_groups

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

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

Method definition

def search_skill_groups(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
) -> SearchSkillGroupsResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchSkillGroupsResponseTypeDef

Usage example with kwargs

kwargs: SearchSkillGroupsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.search_skill_groups(**kwargs)

1. See SearchSkillGroupsRequestRequestTypeDef

search_users

Searches users and lists the ones that meet a set of filter and sort criteria.

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

Method definition

def search_users(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    SortCriteria: Sequence[SortTypeDef] = ...,  # (2)
) -> SearchUsersResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See SortTypeDef
3. See SearchUsersResponseTypeDef

Usage example with kwargs

kwargs: SearchUsersRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.search_users(**kwargs)

1. See SearchUsersRequestRequestTypeDef

send_announcement

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

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

Method definition

def send_announcement(
    self,
    *,
    RoomFilters: Sequence[FilterTypeDef],  # (1)
    Content: ContentTypeDef,  # (2)
    ClientRequestToken: str,
    TimeToLiveInSeconds: int = ...,
) -> SendAnnouncementResponseTypeDef:  # (3)
    ...

1. See FilterTypeDef
2. See ContentTypeDef
3. See SendAnnouncementResponseTypeDef

Usage example with kwargs

kwargs: SendAnnouncementRequestRequestTypeDef = {  # (1)
    "RoomFilters": ...,
    "Content": ...,
    "ClientRequestToken": ...,
}

parent.send_announcement(**kwargs)

1. See SendAnnouncementRequestRequestTypeDef

send_invitation

Sends an enrollment invitation email with a URL to a user.

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

Method definition

def send_invitation(
    self,
    *,
    UserArn: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: SendInvitationRequestRequestTypeDef = {  # (1)
    "UserArn": ...,
}

parent.send_invitation(**kwargs)

1. See SendInvitationRequestRequestTypeDef

start_device_sync

Resets a device and its account to the known default settings.

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

Method definition

def start_device_sync(
    self,
    *,
    Features: Sequence[FeatureType],  # (1)
    RoomArn: str = ...,
    DeviceArn: str = ...,
) -> Dict[str, Any]:
    ...

1. See FeatureType

Usage example with kwargs

kwargs: StartDeviceSyncRequestRequestTypeDef = {  # (1)
    "Features": ...,
}

parent.start_device_sync(**kwargs)

1. See StartDeviceSyncRequestRequestTypeDef

start_smart_home_appliance_discovery

Initiates the discovery of any smart home appliances associated with the room.

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

Method definition

def start_smart_home_appliance_discovery(
    self,
    *,
    RoomArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StartSmartHomeApplianceDiscoveryRequestRequestTypeDef = {  # (1)
    "RoomArn": ...,
}

parent.start_smart_home_appliance_discovery(**kwargs)

1. See StartSmartHomeApplianceDiscoveryRequestRequestTypeDef

tag_resource

Adds metadata tags to a specified resource.

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

Method definition

def tag_resource(
    self,
    *,
    Arn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "Arn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes metadata tags from a specified resource.

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

Method definition

def untag_resource(
    self,
    *,
    Arn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "Arn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_address_book

Updates address book details by the address book ARN.

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

Method definition

def update_address_book(
    self,
    *,
    AddressBookArn: str,
    Name: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateAddressBookRequestRequestTypeDef = {  # (1)
    "AddressBookArn": ...,
}

parent.update_address_book(**kwargs)

1. See UpdateAddressBookRequestRequestTypeDef

update_business_report_schedule

Updates the configuration of the report delivery schedule with the specified schedule ARN.

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

Method definition

def update_business_report_schedule(
    self,
    *,
    ScheduleArn: str,
    S3BucketName: str = ...,
    S3KeyPrefix: str = ...,
    Format: BusinessReportFormatType = ...,  # (1)
    ScheduleName: str = ...,
    Recurrence: BusinessReportRecurrenceTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See BusinessReportFormatType
2. See BusinessReportRecurrenceTypeDef

Usage example with kwargs

kwargs: UpdateBusinessReportScheduleRequestRequestTypeDef = {  # (1)
    "ScheduleArn": ...,
}

parent.update_business_report_schedule(**kwargs)

1. See UpdateBusinessReportScheduleRequestRequestTypeDef

update_conference_provider

Updates an existing conference provider's settings.

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

Method definition

def update_conference_provider(
    self,
    *,
    ConferenceProviderArn: str,
    ConferenceProviderType: ConferenceProviderTypeType,  # (1)
    MeetingSetting: MeetingSettingTypeDef,  # (2)
    IPDialIn: IPDialInTypeDef = ...,  # (3)
    PSTNDialIn: PSTNDialInTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See ConferenceProviderTypeType
2. See MeetingSettingTypeDef
3. See IPDialInTypeDef
4. See PSTNDialInTypeDef

Usage example with kwargs

kwargs: UpdateConferenceProviderRequestRequestTypeDef = {  # (1)
    "ConferenceProviderArn": ...,
    "ConferenceProviderType": ...,
    "MeetingSetting": ...,
}

parent.update_conference_provider(**kwargs)

1. See UpdateConferenceProviderRequestRequestTypeDef

update_contact

Updates the contact details by the contact ARN.

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

Method definition

def update_contact(
    self,
    *,
    ContactArn: str,
    DisplayName: str = ...,
    FirstName: str = ...,
    LastName: str = ...,
    PhoneNumber: str = ...,
    PhoneNumbers: Sequence[PhoneNumberTypeDef] = ...,  # (1)
    SipAddresses: Sequence[SipAddressTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See PhoneNumberTypeDef
2. See SipAddressTypeDef

Usage example with kwargs

kwargs: UpdateContactRequestRequestTypeDef = {  # (1)
    "ContactArn": ...,
}

parent.update_contact(**kwargs)

1. See UpdateContactRequestRequestTypeDef

update_device

Updates the device name by device ARN.

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

Method definition

def update_device(
    self,
    *,
    DeviceArn: str = ...,
    DeviceName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateDeviceRequestRequestTypeDef = {  # (1)
    "DeviceArn": ...,
}

parent.update_device(**kwargs)

1. See UpdateDeviceRequestRequestTypeDef

update_gateway

Updates the details of a gateway.

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

Method definition

def update_gateway(
    self,
    *,
    GatewayArn: str,
    Name: str = ...,
    Description: str = ...,
    SoftwareVersion: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateGatewayRequestRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.update_gateway(**kwargs)

1. See UpdateGatewayRequestRequestTypeDef

update_gateway_group

Updates the details of a gateway group.

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

Method definition

def update_gateway_group(
    self,
    *,
    GatewayGroupArn: str,
    Name: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateGatewayGroupRequestRequestTypeDef = {  # (1)
    "GatewayGroupArn": ...,
}

parent.update_gateway_group(**kwargs)

1. See UpdateGatewayGroupRequestRequestTypeDef

update_network_profile

Updates a network profile by the network profile ARN.

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

Method definition

def update_network_profile(
    self,
    *,
    NetworkProfileArn: str,
    NetworkProfileName: str = ...,
    Description: str = ...,
    CurrentPassword: str = ...,
    NextPassword: str = ...,
    CertificateAuthorityArn: str = ...,
    TrustAnchors: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateNetworkProfileRequestRequestTypeDef = {  # (1)
    "NetworkProfileArn": ...,
}

parent.update_network_profile(**kwargs)

1. See UpdateNetworkProfileRequestRequestTypeDef

update_profile

Updates an existing room profile by room profile ARN.

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

Method definition

def update_profile(
    self,
    *,
    ProfileArn: str = ...,
    ProfileName: str = ...,
    IsDefault: bool = ...,
    Timezone: str = ...,
    Address: str = ...,
    DistanceUnit: DistanceUnitType = ...,  # (1)
    TemperatureUnit: TemperatureUnitType = ...,  # (2)
    WakeWord: WakeWordType = ...,  # (3)
    Locale: str = ...,
    SetupModeDisabled: bool = ...,
    MaxVolumeLimit: int = ...,
    PSTNEnabled: bool = ...,
    DataRetentionOptIn: bool = ...,
    MeetingRoomConfiguration: UpdateMeetingRoomConfigurationTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See DistanceUnitType
2. See TemperatureUnitType
3. See WakeWordType
4. See UpdateMeetingRoomConfigurationTypeDef

Usage example with kwargs

kwargs: UpdateProfileRequestRequestTypeDef = {  # (1)
    "ProfileArn": ...,
}

parent.update_profile(**kwargs)

1. See UpdateProfileRequestRequestTypeDef

update_room

Updates room details by room ARN.

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

Method definition

def update_room(
    self,
    *,
    RoomArn: str = ...,
    RoomName: str = ...,
    Description: str = ...,
    ProviderCalendarId: str = ...,
    ProfileArn: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateRoomRequestRequestTypeDef = {  # (1)
    "RoomArn": ...,
}

parent.update_room(**kwargs)

1. See UpdateRoomRequestRequestTypeDef

update_skill_group

Updates skill group details by skill group ARN.

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

Method definition

def update_skill_group(
    self,
    *,
    SkillGroupArn: str = ...,
    SkillGroupName: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateSkillGroupRequestRequestTypeDef = {  # (1)
    "SkillGroupArn": ...,
}

parent.update_skill_group(**kwargs)

1. See UpdateSkillGroupRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("alexaforbusiness").get_paginator method with overloads.

• client.get_paginator("list_business_report_schedules") -> ListBusinessReportSchedulesPaginator
• client.get_paginator("list_conference_providers") -> ListConferenceProvidersPaginator
• client.get_paginator("list_device_events") -> ListDeviceEventsPaginator
• client.get_paginator("list_skills") -> ListSkillsPaginator
• client.get_paginator("list_skills_store_categories") -> ListSkillsStoreCategoriesPaginator
• client.get_paginator("list_skills_store_skills_by_category") -> ListSkillsStoreSkillsByCategoryPaginator
• client.get_paginator("list_smart_home_appliances") -> ListSmartHomeAppliancesPaginator
• client.get_paginator("list_tags") -> ListTagsPaginator
• client.get_paginator("search_devices") -> SearchDevicesPaginator
• client.get_paginator("search_profiles") -> SearchProfilesPaginator
• client.get_paginator("search_rooms") -> SearchRoomsPaginator
• client.get_paginator("search_skill_groups") -> SearchSkillGroupsPaginator
• client.get_paginator("search_users") -> SearchUsersPaginator