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
# AlexaForBusinessClient 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.
# Exceptions.exceptions usage example
client = boto3.client("alexaforbusiness")
try:
do_something(client)
except (
client.exceptions.AlreadyExistsException,
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.DeviceNotRegisteredException,
client.exceptions.InvalidCertificateAuthorityException,
client.exceptions.InvalidDeviceException,
client.exceptions.InvalidSecretsManagerResourceException,
client.exceptions.InvalidServiceLinkedRoleStateException,
client.exceptions.InvalidUserStatusException,
client.exceptions.LimitExceededException,
client.exceptions.NameInUseException,
client.exceptions.NotFoundException,
client.exceptions.ResourceAssociatedException,
client.exceptions.ResourceInUseException,
client.exceptions.SkillNotLinkedException,
client.exceptions.UnauthorizedException,
) as e:
print(e)
# Exceptions.exceptions 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
# approve_skill method definition
def approve_skill(
self,
*,
SkillId: str,
) -> Dict[str, Any]:
...
# approve_skill method usage example with argument unpacking
kwargs: ApproveSkillRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.approve_skill(**kwargs)
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
# associate_contact_with_address_book method definition
def associate_contact_with_address_book(
self,
*,
ContactArn: str,
AddressBookArn: str,
) -> Dict[str, Any]:
...
# associate_contact_with_address_book method usage example with argument unpacking
kwargs: AssociateContactWithAddressBookRequestRequestTypeDef = { # (1)
"ContactArn": ...,
"AddressBookArn": ...,
}
parent.associate_contact_with_address_book(**kwargs)
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
# associate_device_with_network_profile method definition
def associate_device_with_network_profile(
self,
*,
DeviceArn: str,
NetworkProfileArn: str,
) -> Dict[str, Any]:
...
# associate_device_with_network_profile method usage example with argument unpacking
kwargs: AssociateDeviceWithNetworkProfileRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
"NetworkProfileArn": ...,
}
parent.associate_device_with_network_profile(**kwargs)
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
# associate_device_with_room method definition
def associate_device_with_room(
self,
*,
DeviceArn: str = ...,
RoomArn: str = ...,
) -> Dict[str, Any]:
...
# associate_device_with_room method usage example with argument unpacking
kwargs: AssociateDeviceWithRoomRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
}
parent.associate_device_with_room(**kwargs)
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
# associate_skill_group_with_room method definition
def associate_skill_group_with_room(
self,
*,
SkillGroupArn: str = ...,
RoomArn: str = ...,
) -> Dict[str, Any]:
...
# associate_skill_group_with_room method usage example with argument unpacking
kwargs: AssociateSkillGroupWithRoomRequestRequestTypeDef = { # (1)
"SkillGroupArn": ...,
}
parent.associate_skill_group_with_room(**kwargs)
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
# associate_skill_with_skill_group method definition
def associate_skill_with_skill_group(
self,
*,
SkillId: str,
SkillGroupArn: str = ...,
) -> Dict[str, Any]:
...
# associate_skill_with_skill_group method usage example with argument unpacking
kwargs: AssociateSkillWithSkillGroupRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.associate_skill_with_skill_group(**kwargs)
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
# associate_skill_with_users method definition
def associate_skill_with_users(
self,
*,
SkillId: str,
) -> Dict[str, Any]:
...
# associate_skill_with_users method usage example with argument unpacking
kwargs: AssociateSkillWithUsersRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.associate_skill_with_users(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("alexaforbusiness").can_paginate
method.
boto3 documentation
# can_paginate 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
# close 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
# create_address_book method definition
def create_address_book(
self,
*,
Name: str,
Description: str = ...,
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAddressBookResponseTypeDef: # (2)
...
# create_address_book method usage example with argument unpacking
kwargs: CreateAddressBookRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_address_book(**kwargs)
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
# create_business_report_schedule 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)
...
- See BusinessReportFormatType
- See BusinessReportContentRangeTypeDef
- See BusinessReportRecurrenceTypeDef
- See TagTypeDef
- See CreateBusinessReportScheduleResponseTypeDef
# create_business_report_schedule method usage example with argument unpacking
kwargs: CreateBusinessReportScheduleRequestRequestTypeDef = { # (1)
"Format": ...,
"ContentRange": ...,
}
parent.create_business_report_schedule(**kwargs)
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
# create_conference_provider 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)
...
- See ConferenceProviderTypeType
- See MeetingSettingTypeDef
- See IPDialInTypeDef
- See PSTNDialInTypeDef
- See TagTypeDef
- See CreateConferenceProviderResponseTypeDef
# create_conference_provider method usage example with argument unpacking
kwargs: CreateConferenceProviderRequestRequestTypeDef = { # (1)
"ConferenceProviderName": ...,
"ConferenceProviderType": ...,
"MeetingSetting": ...,
}
parent.create_conference_provider(**kwargs)
create_contact#
Creates a contact with the specified details.
Type annotations and code completion for boto3.client("alexaforbusiness").create_contact
method.
boto3 documentation
# create_contact 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)
...
- See PhoneNumberTypeDef
- See SipAddressTypeDef
- See TagTypeDef
- See CreateContactResponseTypeDef
# create_contact method usage example with argument unpacking
kwargs: CreateContactRequestRequestTypeDef = { # (1)
"FirstName": ...,
}
parent.create_contact(**kwargs)
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
# create_gateway_group method definition
def create_gateway_group(
self,
*,
Name: str,
ClientRequestToken: str,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateGatewayGroupResponseTypeDef: # (2)
...
# create_gateway_group method usage example with argument unpacking
kwargs: CreateGatewayGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"ClientRequestToken": ...,
}
parent.create_gateway_group(**kwargs)
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
# create_network_profile 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)
...
- See NetworkSecurityTypeType
- See NetworkEapMethodType
- See TagTypeDef
- See CreateNetworkProfileResponseTypeDef
# create_network_profile method usage example with argument unpacking
kwargs: CreateNetworkProfileRequestRequestTypeDef = { # (1)
"NetworkProfileName": ...,
"Ssid": ...,
"SecurityType": ...,
"ClientRequestToken": ...,
}
parent.create_network_profile(**kwargs)
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
# create_profile 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)
...
- See DistanceUnitType
- See TemperatureUnitType
- See WakeWordType
- See CreateMeetingRoomConfigurationTypeDef
- See TagTypeDef
- See CreateProfileResponseTypeDef
# create_profile method usage example with argument unpacking
kwargs: CreateProfileRequestRequestTypeDef = { # (1)
"ProfileName": ...,
"Timezone": ...,
"Address": ...,
"DistanceUnit": ...,
"TemperatureUnit": ...,
"WakeWord": ...,
}
parent.create_profile(**kwargs)
create_room#
Creates a room with the specified details.
Type annotations and code completion for boto3.client("alexaforbusiness").create_room
method.
boto3 documentation
# create_room method definition
def create_room(
self,
*,
RoomName: str,
Description: str = ...,
ProfileArn: str = ...,
ProviderCalendarId: str = ...,
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateRoomResponseTypeDef: # (2)
...
- See TagTypeDef
- See CreateRoomResponseTypeDef
# create_room method usage example with argument unpacking
kwargs: CreateRoomRequestRequestTypeDef = { # (1)
"RoomName": ...,
}
parent.create_room(**kwargs)
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
# create_skill_group method definition
def create_skill_group(
self,
*,
SkillGroupName: str,
Description: str = ...,
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSkillGroupResponseTypeDef: # (2)
...
# create_skill_group method usage example with argument unpacking
kwargs: CreateSkillGroupRequestRequestTypeDef = { # (1)
"SkillGroupName": ...,
}
parent.create_skill_group(**kwargs)
create_user#
Creates a user.
Type annotations and code completion for boto3.client("alexaforbusiness").create_user
method.
boto3 documentation
# create_user method definition
def create_user(
self,
*,
UserId: str,
FirstName: str = ...,
LastName: str = ...,
Email: str = ...,
ClientRequestToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateUserResponseTypeDef: # (2)
...
- See TagTypeDef
- See CreateUserResponseTypeDef
# create_user method usage example with argument unpacking
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"UserId": ...,
}
parent.create_user(**kwargs)
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
# delete_address_book method definition
def delete_address_book(
self,
*,
AddressBookArn: str,
) -> Dict[str, Any]:
...
# delete_address_book method usage example with argument unpacking
kwargs: DeleteAddressBookRequestRequestTypeDef = { # (1)
"AddressBookArn": ...,
}
parent.delete_address_book(**kwargs)
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
# delete_business_report_schedule method definition
def delete_business_report_schedule(
self,
*,
ScheduleArn: str,
) -> Dict[str, Any]:
...
# delete_business_report_schedule method usage example with argument unpacking
kwargs: DeleteBusinessReportScheduleRequestRequestTypeDef = { # (1)
"ScheduleArn": ...,
}
parent.delete_business_report_schedule(**kwargs)
delete_conference_provider#
Deletes a conference provider.
Type annotations and code completion for boto3.client("alexaforbusiness").delete_conference_provider
method.
boto3 documentation
# delete_conference_provider method definition
def delete_conference_provider(
self,
*,
ConferenceProviderArn: str,
) -> Dict[str, Any]:
...
# delete_conference_provider method usage example with argument unpacking
kwargs: DeleteConferenceProviderRequestRequestTypeDef = { # (1)
"ConferenceProviderArn": ...,
}
parent.delete_conference_provider(**kwargs)
delete_contact#
Deletes a contact by the contact ARN.
Type annotations and code completion for boto3.client("alexaforbusiness").delete_contact
method.
boto3 documentation
# delete_contact method definition
def delete_contact(
self,
*,
ContactArn: str,
) -> Dict[str, Any]:
...
# delete_contact method usage example with argument unpacking
kwargs: DeleteContactRequestRequestTypeDef = { # (1)
"ContactArn": ...,
}
parent.delete_contact(**kwargs)
delete_device#
Removes a device from Alexa For Business.
Type annotations and code completion for boto3.client("alexaforbusiness").delete_device
method.
boto3 documentation
# delete_device method definition
def delete_device(
self,
*,
DeviceArn: str,
) -> Dict[str, Any]:
...
# delete_device method usage example with argument unpacking
kwargs: DeleteDeviceRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
}
parent.delete_device(**kwargs)
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
# delete_device_usage_data method definition
def delete_device_usage_data(
self,
*,
DeviceArn: str,
DeviceUsageType: DeviceUsageTypeType, # (1)
) -> Dict[str, Any]:
...
# delete_device_usage_data method usage example with argument unpacking
kwargs: DeleteDeviceUsageDataRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
"DeviceUsageType": ...,
}
parent.delete_device_usage_data(**kwargs)
delete_gateway_group#
Deletes a gateway group.
Type annotations and code completion for boto3.client("alexaforbusiness").delete_gateway_group
method.
boto3 documentation
# delete_gateway_group method definition
def delete_gateway_group(
self,
*,
GatewayGroupArn: str,
) -> Dict[str, Any]:
...
# delete_gateway_group method usage example with argument unpacking
kwargs: DeleteGatewayGroupRequestRequestTypeDef = { # (1)
"GatewayGroupArn": ...,
}
parent.delete_gateway_group(**kwargs)
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
# delete_network_profile method definition
def delete_network_profile(
self,
*,
NetworkProfileArn: str,
) -> Dict[str, Any]:
...
# delete_network_profile method usage example with argument unpacking
kwargs: DeleteNetworkProfileRequestRequestTypeDef = { # (1)
"NetworkProfileArn": ...,
}
parent.delete_network_profile(**kwargs)
delete_profile#
Deletes a room profile by the profile ARN.
Type annotations and code completion for boto3.client("alexaforbusiness").delete_profile
method.
boto3 documentation
# delete_profile method definition
def delete_profile(
self,
*,
ProfileArn: str = ...,
) -> Dict[str, Any]:
...
# delete_profile method usage example with argument unpacking
kwargs: DeleteProfileRequestRequestTypeDef = { # (1)
"ProfileArn": ...,
}
parent.delete_profile(**kwargs)
delete_room#
Deletes a room by the room ARN.
Type annotations and code completion for boto3.client("alexaforbusiness").delete_room
method.
boto3 documentation
# delete_room method definition
def delete_room(
self,
*,
RoomArn: str = ...,
) -> Dict[str, Any]:
...
# delete_room method usage example with argument unpacking
kwargs: DeleteRoomRequestRequestTypeDef = { # (1)
"RoomArn": ...,
}
parent.delete_room(**kwargs)
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
# delete_room_skill_parameter method definition
def delete_room_skill_parameter(
self,
*,
SkillId: str,
ParameterKey: str,
RoomArn: str = ...,
) -> Dict[str, Any]:
...
# delete_room_skill_parameter method usage example with argument unpacking
kwargs: DeleteRoomSkillParameterRequestRequestTypeDef = { # (1)
"SkillId": ...,
"ParameterKey": ...,
}
parent.delete_room_skill_parameter(**kwargs)
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
# delete_skill_authorization method definition
def delete_skill_authorization(
self,
*,
SkillId: str,
RoomArn: str = ...,
) -> Dict[str, Any]:
...
# delete_skill_authorization method usage example with argument unpacking
kwargs: DeleteSkillAuthorizationRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.delete_skill_authorization(**kwargs)
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
# delete_skill_group method definition
def delete_skill_group(
self,
*,
SkillGroupArn: str = ...,
) -> Dict[str, Any]:
...
# delete_skill_group method usage example with argument unpacking
kwargs: DeleteSkillGroupRequestRequestTypeDef = { # (1)
"SkillGroupArn": ...,
}
parent.delete_skill_group(**kwargs)
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
# delete_user method definition
def delete_user(
self,
*,
EnrollmentId: str,
UserArn: str = ...,
) -> Dict[str, Any]:
...
# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"EnrollmentId": ...,
}
parent.delete_user(**kwargs)
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
# disassociate_contact_from_address_book method definition
def disassociate_contact_from_address_book(
self,
*,
ContactArn: str,
AddressBookArn: str,
) -> Dict[str, Any]:
...
# disassociate_contact_from_address_book method usage example with argument unpacking
kwargs: DisassociateContactFromAddressBookRequestRequestTypeDef = { # (1)
"ContactArn": ...,
"AddressBookArn": ...,
}
parent.disassociate_contact_from_address_book(**kwargs)
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
# disassociate_device_from_room method definition
def disassociate_device_from_room(
self,
*,
DeviceArn: str = ...,
) -> Dict[str, Any]:
...
# disassociate_device_from_room method usage example with argument unpacking
kwargs: DisassociateDeviceFromRoomRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
}
parent.disassociate_device_from_room(**kwargs)
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
# disassociate_skill_from_skill_group method definition
def disassociate_skill_from_skill_group(
self,
*,
SkillId: str,
SkillGroupArn: str = ...,
) -> Dict[str, Any]:
...
# disassociate_skill_from_skill_group method usage example with argument unpacking
kwargs: DisassociateSkillFromSkillGroupRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.disassociate_skill_from_skill_group(**kwargs)
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
# disassociate_skill_from_users method definition
def disassociate_skill_from_users(
self,
*,
SkillId: str,
) -> Dict[str, Any]:
...
# disassociate_skill_from_users method usage example with argument unpacking
kwargs: DisassociateSkillFromUsersRequestRequestTypeDef = { # (1)
"SkillId": ...,
}
parent.disassociate_skill_from_users(**kwargs)
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
# disassociate_skill_group_from_room method definition
def disassociate_skill_group_from_room(
self,
*,
SkillGroupArn: str = ...,
RoomArn: str = ...,
) -> Dict[str, Any]:
...
# disassociate_skill_group_from_room method usage example with argument unpacking
kwargs: DisassociateSkillGroupFromRoomRequestRequestTypeDef = { # (1)
"SkillGroupArn": ...,
}
parent.disassociate_skill_group_from_room(**kwargs)
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
# forget_smart_home_appliances method definition
def forget_smart_home_appliances(
self,
*,
RoomArn: str,
) -> Dict[str, Any]:
...
# forget_smart_home_appliances method usage example with argument unpacking
kwargs: ForgetSmartHomeAppliancesRequestRequestTypeDef = { # (1)
"RoomArn": ...,
}
parent.forget_smart_home_appliances(**kwargs)
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
# generate_presigned_url 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
# get_address_book method definition
def get_address_book(
self,
*,
AddressBookArn: str,
) -> GetAddressBookResponseTypeDef: # (1)
...
# get_address_book method usage example with argument unpacking
kwargs: GetAddressBookRequestRequestTypeDef = { # (1)
"AddressBookArn": ...,
}
parent.get_address_book(**kwargs)
get_conference_preference#
Retrieves the existing conference preferences.
Type annotations and code completion for boto3.client("alexaforbusiness").get_conference_preference
method.
boto3 documentation
# get_conference_preference method definition
def get_conference_preference(
self,
) -> GetConferencePreferenceResponseTypeDef: # (1)
...
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
# get_conference_provider method definition
def get_conference_provider(
self,
*,
ConferenceProviderArn: str,
) -> GetConferenceProviderResponseTypeDef: # (1)
...
# get_conference_provider method usage example with argument unpacking
kwargs: GetConferenceProviderRequestRequestTypeDef = { # (1)
"ConferenceProviderArn": ...,
}
parent.get_conference_provider(**kwargs)
get_contact#
Gets the contact details by the contact ARN.
Type annotations and code completion for boto3.client("alexaforbusiness").get_contact
method.
boto3 documentation
# get_contact method definition
def get_contact(
self,
*,
ContactArn: str,
) -> GetContactResponseTypeDef: # (1)
...
# get_contact method usage example with argument unpacking
kwargs: GetContactRequestRequestTypeDef = { # (1)
"ContactArn": ...,
}
parent.get_contact(**kwargs)
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
# get_device method definition
def get_device(
self,
*,
DeviceArn: str = ...,
) -> GetDeviceResponseTypeDef: # (1)
...
# get_device method usage example with argument unpacking
kwargs: GetDeviceRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
}
parent.get_device(**kwargs)
get_gateway#
Retrieves the details of a gateway.
Type annotations and code completion for boto3.client("alexaforbusiness").get_gateway
method.
boto3 documentation
# get_gateway method definition
def get_gateway(
self,
*,
GatewayArn: str,
) -> GetGatewayResponseTypeDef: # (1)
...
# get_gateway method usage example with argument unpacking
kwargs: GetGatewayRequestRequestTypeDef = { # (1)
"GatewayArn": ...,
}
parent.get_gateway(**kwargs)
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
# get_gateway_group method definition
def get_gateway_group(
self,
*,
GatewayGroupArn: str,
) -> GetGatewayGroupResponseTypeDef: # (1)
...
# get_gateway_group method usage example with argument unpacking
kwargs: GetGatewayGroupRequestRequestTypeDef = { # (1)
"GatewayGroupArn": ...,
}
parent.get_gateway_group(**kwargs)
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
# get_invitation_configuration method definition
def get_invitation_configuration(
self,
) -> GetInvitationConfigurationResponseTypeDef: # (1)
...
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
# get_network_profile method definition
def get_network_profile(
self,
*,
NetworkProfileArn: str,
) -> GetNetworkProfileResponseTypeDef: # (1)
...
# get_network_profile method usage example with argument unpacking
kwargs: GetNetworkProfileRequestRequestTypeDef = { # (1)
"NetworkProfileArn": ...,
}
parent.get_network_profile(**kwargs)
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
# get_profile method definition
def get_profile(
self,
*,
ProfileArn: str = ...,
) -> GetProfileResponseTypeDef: # (1)
...
# get_profile method usage example with argument unpacking
kwargs: GetProfileRequestRequestTypeDef = { # (1)
"ProfileArn": ...,
}
parent.get_profile(**kwargs)
get_room#
Gets room details by room ARN.
Type annotations and code completion for boto3.client("alexaforbusiness").get_room
method.
boto3 documentation
# get_room method definition
def get_room(
self,
*,
RoomArn: str = ...,
) -> GetRoomResponseTypeDef: # (1)
...
# get_room method usage example with argument unpacking
kwargs: GetRoomRequestRequestTypeDef = { # (1)
"RoomArn": ...,
}
parent.get_room(**kwargs)
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
# get_room_skill_parameter method definition
def get_room_skill_parameter(
self,
*,
SkillId: str,
ParameterKey: str,
RoomArn: str = ...,
) -> GetRoomSkillParameterResponseTypeDef: # (1)
...
# get_room_skill_parameter method usage example with argument unpacking
kwargs: GetRoomSkillParameterRequestRequestTypeDef = { # (1)
"SkillId": ...,
"ParameterKey": ...,
}
parent.get_room_skill_parameter(**kwargs)
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
# get_skill_group method definition
def get_skill_group(
self,
*,
SkillGroupArn: str = ...,
) -> GetSkillGroupResponseTypeDef: # (1)
...
# get_skill_group method usage example with argument unpacking
kwargs: GetSkillGroupRequestRequestTypeDef = { # (1)
"SkillGroupArn": ...,
}
parent.get_skill_group(**kwargs)
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
# list_business_report_schedules method definition
def list_business_report_schedules(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListBusinessReportSchedulesResponseTypeDef: # (1)
...
# list_business_report_schedules method usage example with argument unpacking
kwargs: ListBusinessReportSchedulesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_business_report_schedules(**kwargs)
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
# list_conference_providers method definition
def list_conference_providers(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListConferenceProvidersResponseTypeDef: # (1)
...
# list_conference_providers method usage example with argument unpacking
kwargs: ListConferenceProvidersRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_conference_providers(**kwargs)
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
# list_device_events method definition
def list_device_events(
self,
*,
DeviceArn: str,
EventType: DeviceEventTypeType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDeviceEventsResponseTypeDef: # (2)
...
# list_device_events method usage example with argument unpacking
kwargs: ListDeviceEventsRequestRequestTypeDef = { # (1)
"DeviceArn": ...,
}
parent.list_device_events(**kwargs)
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
# list_gateway_groups method definition
def list_gateway_groups(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGatewayGroupsResponseTypeDef: # (1)
...
# list_gateway_groups method usage example with argument unpacking
kwargs: ListGatewayGroupsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_gateway_groups(**kwargs)
list_gateways#
Retrieves a list of gateway summaries.
Type annotations and code completion for boto3.client("alexaforbusiness").list_gateways
method.
boto3 documentation
# list_gateways method definition
def list_gateways(
self,
*,
GatewayGroupArn: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGatewaysResponseTypeDef: # (1)
...
# list_gateways method usage example with argument unpacking
kwargs: ListGatewaysRequestRequestTypeDef = { # (1)
"GatewayGroupArn": ...,
}
parent.list_gateways(**kwargs)
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
# list_skills method definition
def list_skills(
self,
*,
SkillGroupArn: str = ...,
EnablementType: EnablementTypeFilterType = ..., # (1)
SkillType: SkillTypeFilterType = ..., # (2)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSkillsResponseTypeDef: # (3)
...
# list_skills method usage example with argument unpacking
kwargs: ListSkillsRequestRequestTypeDef = { # (1)
"SkillGroupArn": ...,
}
parent.list_skills(**kwargs)
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
# list_skills_store_categories method definition
def list_skills_store_categories(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSkillsStoreCategoriesResponseTypeDef: # (1)
...
# list_skills_store_categories method usage example with argument unpacking
kwargs: ListSkillsStoreCategoriesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_skills_store_categories(**kwargs)
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
# list_skills_store_skills_by_category method definition
def list_skills_store_skills_by_category(
self,
*,
CategoryId: int,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSkillsStoreSkillsByCategoryResponseTypeDef: # (1)
...
# list_skills_store_skills_by_category method usage example with argument unpacking
kwargs: ListSkillsStoreSkillsByCategoryRequestRequestTypeDef = { # (1)
"CategoryId": ...,
}
parent.list_skills_store_skills_by_category(**kwargs)
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
# list_smart_home_appliances method definition
def list_smart_home_appliances(
self,
*,
RoomArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSmartHomeAppliancesResponseTypeDef: # (1)
...
# list_smart_home_appliances method usage example with argument unpacking
kwargs: ListSmartHomeAppliancesRequestRequestTypeDef = { # (1)
"RoomArn": ...,
}
parent.list_smart_home_appliances(**kwargs)
list_tags#
Lists all tags for the specified resource.
Type annotations and code completion for boto3.client("alexaforbusiness").list_tags
method.
boto3 documentation
# list_tags method definition
def list_tags(
self,
*,
Arn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTagsResponseTypeDef: # (1)
...
# list_tags method usage example with argument unpacking
kwargs: ListTagsRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.list_tags(**kwargs)
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
# put_conference_preference method definition
def put_conference_preference(
self,
*,
ConferencePreference: ConferencePreferenceTypeDef, # (1)
) -> Dict[str, Any]:
...
# put_conference_preference method usage example with argument unpacking
kwargs: PutConferencePreferenceRequestRequestTypeDef = { # (1)
"ConferencePreference": ...,
}
parent.put_conference_preference(**kwargs)
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
# put_invitation_configuration method definition
def put_invitation_configuration(
self,
*,
OrganizationName: str,
ContactEmail: str = ...,
PrivateSkillIds: Sequence[str] = ...,
) -> Dict[str, Any]:
...
# put_invitation_configuration method usage example with argument unpacking
kwargs: PutInvitationConfigurationRequestRequestTypeDef = { # (1)
"OrganizationName": ...,
}
parent.put_invitation_configuration(**kwargs)
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
# put_room_skill_parameter method definition
def put_room_skill_parameter(
self,
*,
SkillId: str,
RoomSkillParameter: RoomSkillParameterTypeDef, # (1)
RoomArn: str = ...,
) -> Dict[str, Any]:
...
# put_room_skill_parameter method usage example with argument unpacking
kwargs: PutRoomSkillParameterRequestRequestTypeDef = { # (1)
"SkillId": ...,
"RoomSkillParameter": ...,
}
parent.put_room_skill_parameter(**kwargs)
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.