Table of Contents
A low-level client representing Alexa For Business:
import boto3
client = boto3.client('alexaforbusiness')
These are the available methods:
Associates a contact with a given address book.
See also: AWS API Documentation
Request Syntax
response = client.associate_contact_with_address_book(
ContactArn='string',
AddressBookArn='string'
)
[REQUIRED]
The ARN of the contact to associate with an address book.
[REQUIRED]
The ARN of the address book with which to associate the contact.
dict
Response Syntax
{}
Response Structure
Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
See also: AWS API Documentation
Request Syntax
response = client.associate_device_with_room(
DeviceArn='string',
RoomArn='string'
)
dict
Response Syntax
{}
Response Structure
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
See also: AWS API Documentation
Request Syntax
response = client.associate_skill_group_with_room(
SkillGroupArn='string',
RoomArn='string'
)
dict
Response Syntax
{}
Response Structure
Check if an operation can be paginated.
Creates an address book with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_address_book(
Name='string',
Description='string',
ClientRequestToken='string'
)
[REQUIRED]
The name of the address book.
A unique, user-specified identifier for the request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AddressBookArn': 'string'
}
Response Structure
(dict) --
AddressBookArn (string) --
The ARN of the newly created address book.
Creates a contact with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_contact(
DisplayName='string',
FirstName='string',
LastName='string',
PhoneNumber='string',
ClientRequestToken='string'
)
[REQUIRED]
The first name of the contact that is used to call the contact on the device.
[REQUIRED]
The phone number of the contact in E.164 format.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactArn (string) --
The ARN of the newly created address book.
Creates a new room profile with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_profile(
ProfileName='string',
Timezone='string',
Address='string',
DistanceUnit='METRIC'|'IMPERIAL',
TemperatureUnit='FAHRENHEIT'|'CELSIUS',
WakeWord='ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
ClientRequestToken='string',
SetupModeDisabled=True|False,
MaxVolumeLimit=123,
PSTNEnabled=True|False
)
[REQUIRED]
The name of a room profile.
[REQUIRED]
The time zone used by a room profile.
[REQUIRED]
The valid address for the room.
[REQUIRED]
The distance unit to be used by devices in the profile.
[REQUIRED]
The temperature unit to be used by devices in the profile.
[REQUIRED]
A wake word for Alexa, Echo, Amazon, or a computer.
The user-specified token that is used during the creation of a profile.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProfileArn': 'string'
}
Response Structure
(dict) --
ProfileArn (string) --
The ARN of the newly created room profile in the response.
Creates a room with the specified details.
See also: AWS API Documentation
Request Syntax
response = client.create_room(
RoomName='string',
Description='string',
ProfileArn='string',
ProviderCalendarId='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name for the room.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
The tags for the room.
A key-value pair that can be associated with a resource.
The key of a tag. Tag keys are case-sensitive.
The value of a tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{
'RoomArn': 'string'
}
Response Structure
(dict) --
RoomArn (string) --
The ARN of the newly created room in the response.
Creates a skill group with a specified name and description.
See also: AWS API Documentation
Request Syntax
response = client.create_skill_group(
SkillGroupName='string',
Description='string',
ClientRequestToken='string'
)
[REQUIRED]
The name for the skill group.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'SkillGroupArn': 'string'
}
Response Structure
(dict) --
SkillGroupArn (string) --
The ARN of the newly created skill group in the response.
Creates a user.
See also: AWS API Documentation
Request Syntax
response = client.create_user(
UserId='string',
FirstName='string',
LastName='string',
Email='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN for the user.
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
The tags for the user.
A key-value pair that can be associated with a resource.
The key of a tag. Tag keys are case-sensitive.
The value of a tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{
'UserArn': 'string'
}
Response Structure
(dict) --
UserArn (string) --
The ARN of the newly created user in the response.
Deletes an address book by the address book ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_address_book(
AddressBookArn='string'
)
[REQUIRED]
The ARN of the address book to delete.
{}
Response Structure
Deletes a contact by the contact ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact(
ContactArn='string'
)
[REQUIRED]
The ARN of the contact to delete.
{}
Response Structure
Deletes a room profile by the profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_profile(
ProfileArn='string'
)
{}
Response Structure
Deletes a room by the room ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_room(
RoomArn='string'
)
{}
Response Structure
Deletes room skill parameter details by room, skill, and parameter key ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_room_skill_parameter(
RoomArn='string',
SkillId='string',
ParameterKey='string'
)
[REQUIRED]
The ID of the skill from which to remove the room skill parameter details.
[REQUIRED]
The room skill parameter key for which to remove details.
dict
Response Syntax
{}
Response Structure
Deletes a skill group by skill group ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_skill_group(
SkillGroupArn='string'
)
{}
Response Structure
Deletes a specified user by user ARN and enrollment ARN.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
UserArn='string',
EnrollmentId='string'
)
[REQUIRED]
The ARN of the user's enrollment in the organization. Required.
dict
Response Syntax
{}
Response Structure
Disassociates a contact from a given address book.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_contact_from_address_book(
ContactArn='string',
AddressBookArn='string'
)
[REQUIRED]
The ARN of the contact to disassociate from an address book.
[REQUIRED]
The ARN of the address from which to disassociate the contact.
dict
Response Syntax
{}
Response Structure
Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_device_from_room(
DeviceArn='string'
)
{}
Response Structure
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_skill_group_from_room(
SkillGroupArn='string',
RoomArn='string'
)
dict
Response Syntax
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets address the book details by the address book ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_address_book(
AddressBookArn='string'
)
[REQUIRED]
The ARN of the address book for which to request details.
{
'AddressBook': {
'AddressBookArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
The details of the requested address book.
The ARN of the address book.
The name of the address book.
The description of the address book.
Gets the contact details by the contact ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_contact(
ContactArn='string'
)
[REQUIRED]
The ARN of the contact for which to request details.
{
'Contact': {
'ContactArn': 'string',
'DisplayName': 'string',
'FirstName': 'string',
'LastName': 'string',
'PhoneNumber': 'string'
}
}
Response Structure
The details of the requested contact.
The ARN of the contact.
The name of the contact to display on the console.
The first name of the contact, used to call the contact on the device.
The last name of the contact, used to call the contact on the device.
The phone number of the contact.
Gets the details of a device by device ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_device(
DeviceArn='string'
)
{
'Device': {
'DeviceArn': 'string',
'DeviceSerialNumber': 'string',
'DeviceType': 'string',
'DeviceName': 'string',
'SoftwareVersion': 'string',
'MacAddress': 'string',
'RoomArn': 'string',
'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED',
'DeviceStatusInfo': {
'DeviceStatusDetails': [
{
'Code': 'DEVICE_SOFTWARE_UPDATE_NEEDED'|'DEVICE_WAS_OFFLINE'
},
],
'ConnectionStatus': 'ONLINE'|'OFFLINE'
}
}
}
Response Structure
The details of the device requested. Required.
The ARN of a device.
The serial number of a device.
The type of a device.
The name of a device.
The software version of a device.
The MAC address of a device.
The room ARN of a device.
The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
Detailed information about a device's status.
One or more device status detail descriptions.
Details of a device’s status.
The device status detail code.
The latest available information about the connection status of a device.
Create a paginator for an operation.
Gets the details of a room profile by profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_profile(
ProfileArn='string'
)
{
'Profile': {
'ProfileArn': 'string',
'ProfileName': 'string',
'Address': 'string',
'Timezone': 'string',
'DistanceUnit': 'METRIC'|'IMPERIAL',
'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
'SetupModeDisabled': True|False,
'MaxVolumeLimit': 123,
'PSTNEnabled': True|False
}
}
Response Structure
The details of the room profile requested. Required.
The ARN of a room profile.
The name of a room profile.
The address of a room profile.
The time zone of a room profile.
The distance unit of a room profile.
The temperature unit of a room profile.
The wake word of a room profile.
The setup mode of a room profile.
The max volume limit of a room profile.
The PSTN setting of a room profile.
Gets room details by room ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_room(
RoomArn='string'
)
{
'Room': {
'RoomArn': 'string',
'RoomName': 'string',
'Description': 'string',
'ProviderCalendarId': 'string',
'ProfileArn': 'string'
}
}
Response Structure
The details of the room requested.
The ARN of a room.
The name of a room.
The description of a room.
The provider calendar ARN of a room.
The profile ARN of a room.
Gets room skill parameter details by room, skill, and parameter key ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_room_skill_parameter(
RoomArn='string',
SkillId='string',
ParameterKey='string'
)
[REQUIRED]
The ARN of the skill from which to get the room skill parameter details. Required.
[REQUIRED]
The room skill parameter key for which to get details. Required.
dict
Response Syntax
{
'RoomSkillParameter': {
'ParameterKey': 'string',
'ParameterValue': 'string'
}
}
Response Structure
(dict) --
RoomSkillParameter (dict) --
The details of the room skill parameter requested. Required.
ParameterKey (string) --
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
ParameterValue (string) --
The parameter value of a room skill parameter.
Gets skill group details by skill group ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_skill_group(
SkillGroupArn='string'
)
{
'SkillGroup': {
'SkillGroupArn': 'string',
'SkillGroupName': 'string',
'Description': 'string'
}
}
Response Structure
The details of the skill group requested. Required.
The ARN of a skill group.
The name of a skill group.
The description of a skill group.
Returns an object that can wait for some condition.
Lists the device event history, including device connection status, for up to 30 days.
See also: AWS API Documentation
Request Syntax
response = client.list_device_events(
DeviceArn='string',
EventType='CONNECTION_STATUS'|'DEVICE_STATUS',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of a device.
dict
Response Syntax
{
'DeviceEvents': [
{
'Type': 'CONNECTION_STATUS'|'DEVICE_STATUS',
'Value': 'string',
'Timestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DeviceEvents (list) --
The device events requested for the device ARN.
(dict) --
The list of device events.
Type (string) --
The type of device event.
Value (string) --
The value of the event.
Timestamp (datetime) --
The time (in epoch) when the event occurred.
NextToken (string) --
The token returned to indicate that there is more data available.
Lists all enabled skills in a specific skill group.
See also: AWS API Documentation
Request Syntax
response = client.list_skills(
SkillGroupArn='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'SkillSummaries': [
{
'SkillId': 'string',
'SkillName': 'string',
'SupportsLinking': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SkillSummaries (list) --
The list of enabled skills requested. Required.
(dict) --
The summary of skills.
SkillId (string) --
The ARN of the skill summary.
SkillName (string) --
The name of the skill.
SupportsLinking (boolean) --
Linking support for a skill.
NextToken (string) --
The token returned to indicate that there is more data available.
Lists all tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
Arn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the specified resource for which to list tags.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
The tags requested for the specified resource.
(dict) --
A key-value pair that can be associated with a resource.
Key (string) --
The key of a tag. Tag keys are case-sensitive.
Value (string) --
The value of a tag. Tag values are case-sensitive and can be null.
NextToken (string) --
The token returned to indicate that there is more data available.
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
See also: AWS API Documentation
Request Syntax
response = client.put_room_skill_parameter(
RoomArn='string',
SkillId='string',
RoomSkillParameter={
'ParameterKey': 'string',
'ParameterValue': 'string'
}
)
[REQUIRED]
The ARN of the skill associated with the room skill parameter. Required.
[REQUIRED]
The updated room skill parameter. Required.
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
The parameter value of a room skill parameter.
dict
Response Syntax
{}
Response Structure
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
See also: AWS API Documentation
Request Syntax
response = client.resolve_room(
UserId='string',
SkillId='string'
)
[REQUIRED]
The ARN of the user. Required.
[REQUIRED]
The ARN of the skill that was requested. Required.
dict
Response Syntax
{
'RoomArn': 'string',
'RoomName': 'string',
'RoomSkillParameters': [
{
'ParameterKey': 'string',
'ParameterValue': 'string'
},
]
}
Response Structure
(dict) --
RoomArn (string) --
The ARN of the room from which the skill request was invoked.
RoomName (string) --
The name of the room from which the skill request was invoked.
RoomSkillParameters (list) --
Response to get the room profile request. Required.
(dict) --
A skill parameter associated with a room.
ParameterKey (string) --
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
ParameterValue (string) --
The parameter value of a room skill parameter.
Revokes an invitation and invalidates the enrollment URL.
See also: AWS API Documentation
Request Syntax
response = client.revoke_invitation(
UserArn='string',
EnrollmentId='string'
)
dict
Response Syntax
{}
Response Structure
Searches address books and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_address_books(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
NextToken='string',
MaxResults=123
)
The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'AddressBooks': [
{
'AddressBookArn': 'string',
'Name': 'string',
'Description': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
AddressBooks (list) --
The address books that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to an address book.
AddressBookArn (string) --
The ARN of the address book.
Name (string) --
The name of the address book.
Description (string) --
The description of the address book.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of address books returned.
Searches contacts and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_contacts(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
NextToken='string',
MaxResults=123
)
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Contacts': [
{
'ContactArn': 'string',
'DisplayName': 'string',
'FirstName': 'string',
'LastName': 'string',
'PhoneNumber': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Contacts (list) --
The contacts that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to a contact.
ContactArn (string) --
The ARN of the contact.
DisplayName (string) --
The name of the contact to display on the console.
FirstName (string) --
The first name of the contact, used to call the contact on the device.
LastName (string) --
The last name of the contact, used to call the contact on the device.
PhoneNumber (string) --
The phone number of the contact.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of contacts returned.
Searches devices and lists the ones that meet a set of filter criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_devices(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Devices': [
{
'DeviceArn': 'string',
'DeviceSerialNumber': 'string',
'DeviceType': 'string',
'DeviceName': 'string',
'SoftwareVersion': 'string',
'MacAddress': 'string',
'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED',
'RoomArn': 'string',
'RoomName': 'string',
'DeviceStatusInfo': {
'DeviceStatusDetails': [
{
'Code': 'DEVICE_SOFTWARE_UPDATE_NEEDED'|'DEVICE_WAS_OFFLINE'
},
],
'ConnectionStatus': 'ONLINE'|'OFFLINE'
}
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Devices (list) --
The devices that meet the specified set of filter criteria, in sort order.
(dict) --
Device attributes.
DeviceArn (string) --
The ARN of a device.
DeviceSerialNumber (string) --
The serial number of a device.
DeviceType (string) --
The type of a device.
DeviceName (string) --
The name of a device.
SoftwareVersion (string) --
The software version of a device.
MacAddress (string) --
The MAC address of a device.
DeviceStatus (string) --
The status of a device.
RoomArn (string) --
The room ARN associated with a device.
RoomName (string) --
The name of the room associated with a device.
DeviceStatusInfo (dict) --
Detailed information about a device's status.
DeviceStatusDetails (list) --
One or more device status detail descriptions.
(dict) --
Details of a device’s status.
Code (string) --
The device status detail code.
ConnectionStatus (string) --
The latest available information about the connection status of a device.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of devices returned.
Searches room profiles and lists the ones that meet a set of filter criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_profiles(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Profiles': [
{
'ProfileArn': 'string',
'ProfileName': 'string',
'Address': 'string',
'Timezone': 'string',
'DistanceUnit': 'METRIC'|'IMPERIAL',
'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Profiles (list) --
The profiles that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room profile.
ProfileArn (string) --
The ARN of a room profile.
ProfileName (string) --
The name of a room profile.
Address (string) --
The address of a room profile.
Timezone (string) --
The timezone of a room profile.
DistanceUnit (string) --
The distance unit of a room profile.
TemperatureUnit (string) --
The temperature unit of a room profile.
WakeWord (string) --
The wake word of a room profile.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of room profiles returned.
Searches rooms and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_rooms(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Rooms': [
{
'RoomArn': 'string',
'RoomName': 'string',
'Description': 'string',
'ProviderCalendarId': 'string',
'ProfileArn': 'string',
'ProfileName': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Rooms (list) --
The rooms that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room.
RoomArn (string) --
The ARN of a room.
RoomName (string) --
The name of a room.
Description (string) --
The description of a room.
ProviderCalendarId (string) --
The provider calendar ARN of a room.
ProfileArn (string) --
The profile ARN of a room.
ProfileName (string) --
The profile name of a room.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of rooms returned.
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_skill_groups(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'SkillGroups': [
{
'SkillGroupArn': 'string',
'SkillGroupName': 'string',
'Description': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
SkillGroups (list) --
The skill groups that meet the filter criteria, in sort order.
(dict) --
The attributes of a skill group.
SkillGroupArn (string) --
The skill group ARN of a skill group.
SkillGroupName (string) --
The skill group name of a skill group.
Description (string) --
The description of a skill group.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of skill groups returned.
Searches users and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
response = client.search_users(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
dict
Response Syntax
{
'Users': [
{
'UserArn': 'string',
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'EnrollmentStatus': 'INITIALIZED'|'PENDING'|'REGISTERED'|'DISASSOCIATING'|'DEREGISTERING',
'EnrollmentId': 'string'
},
],
'NextToken': 'string',
'TotalCount': 123
}
Response Structure
(dict) --
Users (list) --
The users that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to a user.
UserArn (string) --
The ARN of a user.
FirstName (string) --
The first name of a user.
LastName (string) --
The last name of a user.
Email (string) --
The email of a user.
EnrollmentStatus (string) --
The enrollment status of a user.
EnrollmentId (string) --
The enrollment ARN of a user.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of users returned.
Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.
See also: AWS API Documentation
Request Syntax
response = client.send_invitation(
UserArn='string'
)
{}
Response Structure
Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
See also: AWS API Documentation
Request Syntax
response = client.start_device_sync(
RoomArn='string',
DeviceArn='string',
Features=[
'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'ALL',
]
)
[REQUIRED]
Request structure to start the device sync. Required.
dict
Response Syntax
{}
Response Structure
Adds metadata tags to a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
Arn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the resource to which to add metadata tags. Required.
[REQUIRED]
The tags to be added to the specified resource. Do not provide system tags. Required.
A key-value pair that can be associated with a resource.
The key of a tag. Tag keys are case-sensitive.
The value of a tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{}
Response Structure
Removes metadata tags from a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
Arn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource from which to remove metadata tags. Required.
[REQUIRED]
The tags to be removed from the specified resource. Do not provide system tags. Required.
dict
Response Syntax
{}
Response Structure
Updates address book details by the address book ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_address_book(
AddressBookArn='string',
Name='string',
Description='string'
)
[REQUIRED]
The ARN of the room to update.
dict
Response Syntax
{}
Response Structure
Updates the contact details by the contact ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_contact(
ContactArn='string',
DisplayName='string',
FirstName='string',
LastName='string',
PhoneNumber='string'
)
[REQUIRED]
The ARN of the contact to update.
dict
Response Syntax
{}
Response Structure
Updates the device name by device ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_device(
DeviceArn='string',
DeviceName='string'
)
dict
Response Syntax
{}
Response Structure
Updates an existing room profile by room profile ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_profile(
ProfileArn='string',
ProfileName='string',
Timezone='string',
Address='string',
DistanceUnit='METRIC'|'IMPERIAL',
TemperatureUnit='FAHRENHEIT'|'CELSIUS',
WakeWord='ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
SetupModeDisabled=True|False,
MaxVolumeLimit=123,
PSTNEnabled=True|False
)
dict
Response Syntax
{}
Response Structure
Updates room details by room ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_room(
RoomArn='string',
RoomName='string',
Description='string',
ProviderCalendarId='string',
ProfileArn='string'
)
dict
Response Syntax
{}
Response Structure
Updates skill group details by skill group ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_skill_group(
SkillGroupArn='string',
SkillGroupName='string',
Description='string'
)
dict
Response Syntax
{}
Response Structure
The available paginators are:
paginator = client.get_paginator('list_skills')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_skills().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SkillGroupArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SkillSummaries': [
{
'SkillId': 'string',
'SkillName': 'string',
'SupportsLinking': True|False
},
],
}
Response Structure
(dict) --
SkillSummaries (list) --
The list of enabled skills requested. Required.
(dict) --
The summary of skills.
SkillId (string) --
The ARN of the skill summary.
SkillName (string) --
The name of the skill.
SupportsLinking (boolean) --
Linking support for a skill.
paginator = client.get_paginator('list_tags')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_tags().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Arn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ARN of the specified resource for which to list tags.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Tags (list) --
The tags requested for the specified resource.
(dict) --
A key-value pair that can be associated with a resource.
Key (string) --
The key of a tag. Tag keys are case-sensitive.
Value (string) --
The value of a tag. Tag values are case-sensitive and can be null.
paginator = client.get_paginator('search_devices')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_devices().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Devices': [
{
'DeviceArn': 'string',
'DeviceSerialNumber': 'string',
'DeviceType': 'string',
'DeviceName': 'string',
'SoftwareVersion': 'string',
'MacAddress': 'string',
'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED',
'RoomArn': 'string',
'RoomName': 'string',
'DeviceStatusInfo': {
'DeviceStatusDetails': [
{
'Code': 'DEVICE_SOFTWARE_UPDATE_NEEDED'|'DEVICE_WAS_OFFLINE'
},
],
'ConnectionStatus': 'ONLINE'|'OFFLINE'
}
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Devices (list) --
The devices that meet the specified set of filter criteria, in sort order.
(dict) --
Device attributes.
DeviceArn (string) --
The ARN of a device.
DeviceSerialNumber (string) --
The serial number of a device.
DeviceType (string) --
The type of a device.
DeviceName (string) --
The name of a device.
SoftwareVersion (string) --
The software version of a device.
MacAddress (string) --
The MAC address of a device.
DeviceStatus (string) --
The status of a device.
RoomArn (string) --
The room ARN associated with a device.
RoomName (string) --
The name of the room associated with a device.
DeviceStatusInfo (dict) --
Detailed information about a device's status.
DeviceStatusDetails (list) --
One or more device status detail descriptions.
(dict) --
Details of a device’s status.
Code (string) --
The device status detail code.
ConnectionStatus (string) --
The latest available information about the connection status of a device.
TotalCount (integer) --
The total number of devices returned.
paginator = client.get_paginator('search_profiles')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Profiles': [
{
'ProfileArn': 'string',
'ProfileName': 'string',
'Address': 'string',
'Timezone': 'string',
'DistanceUnit': 'METRIC'|'IMPERIAL',
'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Profiles (list) --
The profiles that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room profile.
ProfileArn (string) --
The ARN of a room profile.
ProfileName (string) --
The name of a room profile.
Address (string) --
The address of a room profile.
Timezone (string) --
The timezone of a room profile.
DistanceUnit (string) --
The distance unit of a room profile.
TemperatureUnit (string) --
The temperature unit of a room profile.
WakeWord (string) --
The wake word of a room profile.
TotalCount (integer) --
The total number of room profiles returned.
paginator = client.get_paginator('search_rooms')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_rooms().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Rooms': [
{
'RoomArn': 'string',
'RoomName': 'string',
'Description': 'string',
'ProviderCalendarId': 'string',
'ProfileArn': 'string',
'ProfileName': 'string'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Rooms (list) --
The rooms that meet the specified set of filter criteria, in sort order.
(dict) --
The data of a room.
RoomArn (string) --
The ARN of a room.
RoomName (string) --
The name of a room.
Description (string) --
The description of a room.
ProviderCalendarId (string) --
The provider calendar ARN of a room.
ProfileArn (string) --
The profile ARN of a room.
ProfileName (string) --
The profile name of a room.
TotalCount (integer) --
The total number of rooms returned.
paginator = client.get_paginator('search_skill_groups')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_skill_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SkillGroups': [
{
'SkillGroupArn': 'string',
'SkillGroupName': 'string',
'Description': 'string'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
SkillGroups (list) --
The skill groups that meet the filter criteria, in sort order.
(dict) --
The attributes of a skill group.
SkillGroupArn (string) --
The skill group ARN of a skill group.
SkillGroupName (string) --
The skill group name of a skill group.
Description (string) --
The description of a skill group.
TotalCount (integer) --
The total number of skill groups returned.
paginator = client.get_paginator('search_users')
Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
The key of a filter.
The values of a filter.
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
An object representing a sort criteria.
The sort key of a sort object.
The sort value of a sort object.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Users': [
{
'UserArn': 'string',
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'EnrollmentStatus': 'INITIALIZED'|'PENDING'|'REGISTERED'|'DISASSOCIATING'|'DEREGISTERING',
'EnrollmentId': 'string'
},
],
'TotalCount': 123
}
Response Structure
(dict) --
Users (list) --
The users that meet the specified set of filter criteria, in sort order.
(dict) --
Information related to a user.
UserArn (string) --
The ARN of a user.
FirstName (string) --
The first name of a user.
LastName (string) --
The last name of a user.
Email (string) --
The email of a user.
EnrollmentStatus (string) --
The enrollment status of a user.
EnrollmentId (string) --
The enrollment ARN of a user.
TotalCount (integer) --
The total number of users returned.