2017/11/30 - Alexa For Business - 36 new api methods
Changes Alexa for Business is now generally available for production use. Alexa for Business makes it easy for you to use Alexa in your organization. The Alexa for Business SDK gives you APIs to manage Alexa devices, enroll users, and assign skills at scale. For more information about Alexa for Business, go to https://aws.amazon.com/alexaforbusiness
Lists all tags for a specific resource.
See also: AWS API Documentation
Request Syntax
client.list_tags(
Arn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ARN of the specific resource for which to list tags. Required.
string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .
integer
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
The list of tags requested for the specific 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.
Gets the details of a device by device ARN.
See also: AWS API Documentation
Request Syntax
client.get_device(
DeviceArn='string'
)
string
The ARN of the device for which to request details. Required.
dict
Response Syntax
{
'Device': {
'DeviceArn': 'string',
'DeviceSerialNumber': 'string',
'DeviceType': 'string',
'DeviceName': 'string',
'SoftwareVersion': 'string',
'MacAddress': 'string',
'RoomArn': 'string',
'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'
}
}
Response Structure
(dict) --
Device (dict) --
The details of the device requested. Required.
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.
RoomArn (string) --
The room ARN of a device.
DeviceStatus (string) --
The status of a device.
Gets room details by room ARN.
See also: AWS API Documentation
Request Syntax
client.get_room(
RoomArn='string'
)
string
The ARN of the room for which to request details. Required.
dict
Response Syntax
{
'Room': {
'RoomArn': 'string',
'RoomName': 'string',
'Description': 'string',
'ProviderCalendarId': 'string',
'ProfileArn': 'string'
}
}
Response Structure
(dict) --
Room (dict) --
The details of the room requested.
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.
Revokes an invitation and invalidates the enrollment URL.
See also: AWS API Documentation
Request Syntax
client.revoke_invitation(
UserArn='string',
EnrollmentId='string'
)
string
The ARN of the user for whom to revoke an enrollment invitation. Required.
string
The ARN of the enrollment invitation to revoke. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
client.search_skill_groups(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults . Required.
integer
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
list
The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of a filter.
Values (list) -- [REQUIRED]
The values of a filter.
(string) --
list
The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
(dict) --
An object representing a sort criteria.
Key (string) -- [REQUIRED]
The sort key of a sort object.
Value (string) -- [REQUIRED]
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.
Deletes a room by the room ARN.
See also: AWS API Documentation
Request Syntax
client.delete_room(
RoomArn='string'
)
string
The ARN of the room to delete. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Associates a device to 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 a manual sync is required.
See also: AWS API Documentation
Request Syntax
client.associate_device_with_room(
DeviceArn='string',
RoomArn='string'
)
string
The ARN of the device to associate to a room. Required.
string
The ARN of the room with which to associate the device. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a specified user by user ARN and enrollment ARN.
See also: AWS API Documentation
Request Syntax
client.delete_user(
UserArn='string',
EnrollmentId='string'
)
string
The ARN of the user to delete in the organization. Required.
string
[REQUIRED]
The ARN of the user's enrollment in the organization. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates room details by room ARN.
See also: AWS API Documentation
Request Syntax
client.update_room(
RoomArn='string',
RoomName='string',
Description='string',
ProviderCalendarId='string',
ProfileArn='string'
)
string
The ARN of the room to update.
string
The updated name for the room.
string
The updated description for the room.
string
The updated provider calendar ARN for the room.
string
The updated profile ARN for the room.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets room skill parameter details by room, skill, and parameter key ARN.
See also: AWS API Documentation
Request Syntax
client.get_room_skill_parameter(
RoomArn='string',
SkillId='string',
ParameterKey='string'
)
string
The ARN of the room from which to get the room skill parameter details.
string
[REQUIRED]
The ARN of the skill from which to get the room skill parameter details. Required.
string
[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.
Creates a skill group with a specified name and description.
See also: AWS API Documentation
Request Syntax
client.create_skill_group(
SkillGroupName='string',
Description='string',
ClientRequestToken='string'
)
string
[REQUIRED]
The name for the skill group.
string
The description for the skill group.
string
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.
Removes metadata tags from a specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
Arn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource from which to remove metadata tags. Required.
list
[REQUIRED]
The tags to be removed from the specified resource. Do not provide system tags. Required.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a room profile by the profile ARN.
See also: AWS API Documentation
Request Syntax
client.delete_profile(
ProfileArn='string'
)
string
The ARN of the room profile to delete. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.disassociate_skill_group_from_room(
SkillGroupArn='string',
RoomArn='string'
)
string
The ARN of the skill group to disassociate from a room. Required.
string
The ARN of the room from which the skill group is to be disassociated. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Associates a skill group to 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
client.associate_skill_group_with_room(
SkillGroupArn='string',
RoomArn='string'
)
string
The ARN of the skill group to associate with a room. Required.
string
The ARN of the room with which to associate the skill group. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches room profiles and lists the ones that meet a set of filter criteria.
See also: AWS API Documentation
Request Syntax
client.search_profiles(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .
integer
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
list
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of a filter.
Values (list) -- [REQUIRED]
The values of a filter.
(string) --
list
The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
(dict) --
An object representing a sort criteria.
Key (string) -- [REQUIRED]
The sort key of a sort object.
Value (string) -- [REQUIRED]
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.
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
client.put_room_skill_parameter(
RoomArn='string',
SkillId='string',
RoomSkillParameter={
'ParameterKey': 'string',
'ParameterValue': 'string'
}
)
string
The ARN of the room associated with the room skill parameter. Required.
string
[REQUIRED]
The ARN of the skill associated with the room skill parameter. Required.
dict
[REQUIRED]
The updated room skill parameter. Required.
ParameterKey (string) -- [REQUIRED]
The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
ParameterValue (string) -- [REQUIRED]
The parameter value of a room skill parameter.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.start_device_sync(
RoomArn='string',
DeviceArn='string',
Features=[
'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'ALL',
]
)
string
The ARN of the room with which the device to sync is associated. Required.
string
The ARN of the device to sync. Required.
list
[REQUIRED]
Request structure to start the device sync. Required.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Gets the details of a room profile by profile ARN.
See also: AWS API Documentation
Request Syntax
client.get_profile(
ProfileArn='string'
)
string
The ARN of the room profile for which to request details. Required.
dict
Response Syntax
{
'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
(dict) --
Profile (dict) --
The details of the room profile requested. Required.
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 time zone 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.
SetupModeDisabled (boolean) --
The setup mode of a room profile.
MaxVolumeLimit (integer) --
The max volume limit of a room profile.
PSTNEnabled (boolean) --
The PSTN setting of a room profile.
Deletes a skill group by skill group ARN.
See also: AWS API Documentation
Request Syntax
client.delete_skill_group(
SkillGroupArn='string'
)
string
The ARN of the skill group to delete. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.resolve_room(
UserId='string',
SkillId='string'
)
string
[REQUIRED]
The ARN of the user. Required.
string
[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.
Searches devices and lists the ones that meet a set of filter criteria.
See also: AWS API Documentation
Request Syntax
client.search_devices(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .
integer
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
list
The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and UnassociatedOnly.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of a filter.
Values (list) -- [REQUIRED]
The values of a filter.
(string) --
list
The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, and DeviceSerialNumber.
(dict) --
An object representing a sort criteria.
Key (string) -- [REQUIRED]
The sort key of a sort object.
Value (string) -- [REQUIRED]
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',
'RoomArn': 'string',
'RoomName': 'string'
},
],
'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.
NextToken (string) --
The token returned to indicate that there is more data available.
TotalCount (integer) --
The total number of devices 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
client.send_invitation(
UserArn='string'
)
string
The ARN of the user to whom to send an invitation. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a user.
See also: AWS API Documentation
Request Syntax
client.create_user(
UserId='string',
FirstName='string',
LastName='string',
Email='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ARN for the user.
string
The first name for the user.
string
The last name for the user.
string
The email address for the user.
string
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
list
The tags for the user.
(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.
dict
Response Syntax
{
'UserArn': 'string'
}
Response Structure
(dict) --
UserArn (string) --
The ARN of the newly created user in the response.
Adds metadata tags to a specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
Arn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ARN of the resource to which to add metadata tags. Required.
list
[REQUIRED]
The tags to be added to the specified resource. Do not provide system tags. Required.
(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.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets skill group details by skill group ARN.
See also: AWS API Documentation
Request Syntax
client.get_skill_group(
SkillGroupArn='string'
)
string
The ARN of the skill group for which to get details. Required.
dict
Response Syntax
{
'SkillGroup': {
'SkillGroupArn': 'string',
'SkillGroupName': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
SkillGroup (dict) --
The details of the skill group requested. Required.
SkillGroupArn (string) --
The ARN of a skill group.
SkillGroupName (string) --
The name of a skill group.
Description (string) --
The description of a skill group.
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
client.disassociate_device_from_room(
DeviceArn='string'
)
string
The ARN of the device to disassociate from a room. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a room with the specified details.
See also: AWS API Documentation
Request Syntax
client.create_room(
RoomName='string',
Description='string',
ProfileArn='string',
ProviderCalendarId='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name for the room.
string
The description for the room.
string
The profile ARN for the room.
string
The calendar ARN for the room.
string
A unique, user-specified identifier for this request that ensures idempotency.
This field is autopopulated if not provided.
list
The tags for the room.
(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.
dict
Response Syntax
{
'RoomArn': 'string'
}
Response Structure
(dict) --
RoomArn (string) --
The ARN of the newly created room in the response.
Updates an existing room profile by room profile ARN.
See also: AWS API Documentation
Request Syntax
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
)
string
The ARN of the room profile to update. Required.
string
The updated name for the room profile.
string
The updated timezone for the room profile.
string
The updated address for the room profile.
string
The updated distance unit for the room profile.
string
The updated temperature unit for the room profile.
string
The updated wake word for the room profile.
boolean
Whether the setup mode of the profile is enabled.
integer
The updated maximum volume limit for the room profile.
boolean
Whether the PSTN setting of the room profile is enabled.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches rooms and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
client.search_rooms(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .
integer
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
list
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of a filter.
Values (list) -- [REQUIRED]
The values of a filter.
(string) --
list
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
(dict) --
An object representing a sort criteria.
Key (string) -- [REQUIRED]
The sort key of a sort object.
Value (string) -- [REQUIRED]
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 users and lists the ones that meet a set of filter and sort criteria.
See also: AWS API Documentation
Request Syntax
client.search_users(
NextToken='string',
MaxResults=123,
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
SortCriteria=[
{
'Key': 'string',
'Value': 'ASC'|'DESC'
},
]
)
string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults . Required.
integer
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
list
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of a filter.
Values (list) -- [REQUIRED]
The values of a filter.
(string) --
list
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
(dict) --
An object representing a sort criteria.
Key (string) -- [REQUIRED]
The sort key of a sort object.
Value (string) -- [REQUIRED]
The sort value of a sort object.
dict
Response Syntax
{
'Users': [
{
'UserArn': 'string',
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'EnrollmentStatus': 'INITIALIZED'|'PENDING'|'REGISTERED'|'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.
Lists all enabled skills in a specific skill group.
See also: AWS API Documentation
Request Syntax
client.list_skills(
SkillGroupArn='string',
NextToken='string',
MaxResults=123
)
string
The ARN of the skill group for which to list enabled skills. Required.
string
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults . Required.
integer
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
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.
Deletes room skill parameter details by room, skill, and parameter key ID.
See also: AWS API Documentation
Request Syntax
client.delete_room_skill_parameter(
RoomArn='string',
SkillId='string',
ParameterKey='string'
)
string
The ARN of the room from which to remove the room skill parameter details.
string
[REQUIRED]
The ID of the skill from which to remove the room skill parameter details.
string
[REQUIRED]
The room skill parameter key for which to remove details.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new room profile with the specified details.
See also: AWS API Documentation
Request Syntax
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
)
string
[REQUIRED]
The name of a room profile.
string
[REQUIRED]
The time zone used by a room profile.
string
[REQUIRED]
The valid address for the room.
string
[REQUIRED]
The distance unit to be used by devices in the profile.
string
[REQUIRED]
The temperature unit to be used by devices in the profile.
string
[REQUIRED]
A wake word for Alexa, Echo, Amazon, or a computer.
string
The user-specified token that is used during the creation of a profile.
This field is autopopulated if not provided.
boolean
Whether room profile setup is enabled.
integer
The maximum volume limit for a room profile.
boolean
Whether PSTN calling is enabled.
dict
Response Syntax
{
'ProfileArn': 'string'
}
Response Structure
(dict) --
ProfileArn (string) --
The ARN of the newly created room profile in the response.
Updates the device name by device ARN.
See also: AWS API Documentation
Request Syntax
client.update_device(
DeviceArn='string',
DeviceName='string'
)
string
The ARN of the device to update. Required.
string
The updated device name. Required.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates skill group details by skill group ARN.
See also: AWS API Documentation
Request Syntax
client.update_skill_group(
SkillGroupArn='string',
SkillGroupName='string',
Description='string'
)
string
The ARN of the skill group to update.
string
The updated name for the skill group.
string
The updated description for the skill group.
dict
Response Syntax
{}
Response Structure
(dict) --