2019/11/25 - Alexa For Business - 5 updated api methods
Changes API update for Alexa for Business: This update enables the use of meeting room configuration that can be applied to a room profile. These settings help improve and measure utilization on Alexa for Business enabled rooms. New features include end meeting reminders, intelligent room release and room utilization analytics report.
{'ContentRange': {'Interval': {'THIRTY_DAYS'}}}
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
See also: AWS API Documentation
Request Syntax
client.create_business_report_schedule(
ScheduleName='string',
S3BucketName='string',
S3KeyPrefix='string',
Format='CSV'|'CSV_ZIP',
ContentRange={
'Interval': 'ONE_DAY'|'ONE_WEEK'|'THIRTY_DAYS'
},
Recurrence={
'StartDate': 'string'
},
ClientRequestToken='string'
)
string
The name identifier of the schedule.
string
The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
string
The S3 key where the report is delivered.
string
[REQUIRED]
The format of the generated report (individual CSV files or zipped files of individual files).
dict
[REQUIRED]
The content range of the reports.
Interval (string) --
The interval of the content range.
dict
The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
StartDate (string) --
The start date.
string
The client request token.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ScheduleArn': 'string'
}
Response Structure
(dict) --
ScheduleArn (string) --
The ARN of the business report schedule.
{'MeetingRoomConfiguration': {'EndOfMeetingReminder': {'Enabled': 'boolean',
'ReminderAtMinutes': ['integer'],
'ReminderType': 'ANNOUNCEMENT_TIME_CHECK '
'| '
'ANNOUNCEMENT_VARIABLE_TIME_LEFT '
'| '
'CHIME '
'| '
'KNOCK'},
'InstantBooking': {'DurationInMinutes': 'integer',
'Enabled': 'boolean'},
'RequireCheckIn': {'Enabled': 'boolean',
'ReleaseAfterMinutes': 'integer'},
'RoomUtilizationMetricsEnabled': 'boolean'}}
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',
Locale='string',
ClientRequestToken='string',
SetupModeDisabled=True|False,
MaxVolumeLimit=123,
PSTNEnabled=True|False,
MeetingRoomConfiguration={
'RoomUtilizationMetricsEnabled': True|False,
'EndOfMeetingReminder': {
'ReminderAtMinutes': [
123,
],
'ReminderType': 'ANNOUNCEMENT_TIME_CHECK'|'ANNOUNCEMENT_VARIABLE_TIME_LEFT'|'CHIME'|'KNOCK',
'Enabled': True|False
},
'InstantBooking': {
'DurationInMinutes': 123,
'Enabled': True|False
},
'RequireCheckIn': {
'ReleaseAfterMinutes': 123,
'Enabled': 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 locale of the room profile. (This is currently only available to a limited preview audience.)
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
The meeting room settings of a room profile.
RoomUtilizationMetricsEnabled (boolean) --
Whether room utilization metrics are enabled or not.
EndOfMeetingReminder (dict) --
Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
ReminderAtMinutes (list) -- [REQUIRED]
A range of 3 to 15 minutes that determines when the reminder begins.
(integer) --
ReminderType (string) -- [REQUIRED]
The type of sound that users hear during the end of meeting reminder.
Enabled (boolean) -- [REQUIRED]
Whether an end of meeting reminder is enabled or not.
InstantBooking (dict) --
Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.
DurationInMinutes (integer) -- [REQUIRED]
Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
Enabled (boolean) -- [REQUIRED]
Whether instant booking is enabled or not.
RequireCheckIn (dict) --
Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
ReleaseAfterMinutes (integer) -- [REQUIRED]
Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
Enabled (boolean) -- [REQUIRED]
Whether require check in is enabled or not.
dict
Response Syntax
{
'ProfileArn': 'string'
}
Response Structure
(dict) --
ProfileArn (string) --
The ARN of the newly created room profile in the response.
{'Profile': {'MeetingRoomConfiguration': {'EndOfMeetingReminder': {'Enabled': 'boolean',
'ReminderAtMinutes': ['integer'],
'ReminderType': 'ANNOUNCEMENT_TIME_CHECK '
'| '
'ANNOUNCEMENT_VARIABLE_TIME_LEFT '
'| '
'CHIME '
'| '
'KNOCK'},
'InstantBooking': {'DurationInMinutes': 'integer',
'Enabled': 'boolean'},
'RequireCheckIn': {'Enabled': 'boolean',
'ReleaseAfterMinutes': 'integer'},
'RoomUtilizationMetricsEnabled': 'boolean'}}}
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',
'IsDefault': True|False,
'Address': 'string',
'Timezone': 'string',
'DistanceUnit': 'METRIC'|'IMPERIAL',
'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
'Locale': 'string',
'SetupModeDisabled': True|False,
'MaxVolumeLimit': 123,
'PSTNEnabled': True|False,
'AddressBookArn': 'string',
'MeetingRoomConfiguration': {
'RoomUtilizationMetricsEnabled': True|False,
'EndOfMeetingReminder': {
'ReminderAtMinutes': [
123,
],
'ReminderType': 'ANNOUNCEMENT_TIME_CHECK'|'ANNOUNCEMENT_VARIABLE_TIME_LEFT'|'CHIME'|'KNOCK',
'Enabled': True|False
},
'InstantBooking': {
'DurationInMinutes': 123,
'Enabled': True|False
},
'RequireCheckIn': {
'ReleaseAfterMinutes': 123,
'Enabled': 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.
IsDefault (boolean) --
Retrieves if the profile is default or not.
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.
Locale (string) --
The locale of a room profile. (This is currently available only to a limited preview audience.)
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.
AddressBookArn (string) --
The ARN of the address book.
MeetingRoomConfiguration (dict) --
Meeting room settings of a room profile.
RoomUtilizationMetricsEnabled (boolean) --
Whether room utilization metrics are enabled or not.
EndOfMeetingReminder (dict) --
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
ReminderAtMinutes (list) --
A range of 3 to 15 minutes that determines when the reminder begins.
(integer) --
ReminderType (string) --
The type of sound that users hear during the end of meeting reminder.
Enabled (boolean) --
Whether an end of meeting reminder is enabled or not.
InstantBooking (dict) --
Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.
DurationInMinutes (integer) --
Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
Enabled (boolean) --
Whether instant booking is enabled or not.
RequireCheckIn (dict) --
Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
ReleaseAfterMinutes (integer) --
Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
Enabled (boolean) --
Whether require check in is enabled or not.
{'BusinessReportSchedules': {'ContentRange': {'Interval': {'THIRTY_DAYS'}}}}
Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
See also: AWS API Documentation
Request Syntax
client.list_business_report_schedules(
NextToken='string',
MaxResults=123
)
string
The token used to list the remaining schedules from the previous API call.
integer
The maximum number of schedules listed in the call.
dict
Response Syntax
{
'BusinessReportSchedules': [
{
'ScheduleArn': 'string',
'ScheduleName': 'string',
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Format': 'CSV'|'CSV_ZIP',
'ContentRange': {
'Interval': 'ONE_DAY'|'ONE_WEEK'|'THIRTY_DAYS'
},
'Recurrence': {
'StartDate': 'string'
},
'LastBusinessReport': {
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
'FailureCode': 'ACCESS_DENIED'|'NO_SUCH_BUCKET'|'INTERNAL_FAILURE',
'S3Location': {
'Path': 'string',
'BucketName': 'string'
},
'DeliveryTime': datetime(2015, 1, 1),
'DownloadUrl': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BusinessReportSchedules (list) --
The schedule of the reports.
(dict) --
The schedule of the usage report.
ScheduleArn (string) --
The ARN of the business report schedule.
ScheduleName (string) --
The name identifier of the schedule.
S3BucketName (string) --
The S3 bucket name of the output reports.
S3KeyPrefix (string) --
The S3 key where the report is delivered.
Format (string) --
The format of the generated report (individual CSV files or zipped files of individual files).
ContentRange (dict) --
The content range of the reports.
Interval (string) --
The interval of the content range.
Recurrence (dict) --
The recurrence of the reports.
StartDate (string) --
The start date.
LastBusinessReport (dict) --
The details of the last business report delivery for a specified time interval.
Status (string) --
The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
FailureCode (string) --
The failure code.
S3Location (dict) --
The S3 location of the output reports.
Path (string) --
The path of the business report.
BucketName (string) --
The S3 bucket name of the output reports.
DeliveryTime (datetime) --
The time of report delivery.
DownloadUrl (string) --
The download link where a user can download the report.
NextToken (string) --
The token used to list the remaining schedules from the previous API call.
{'MeetingRoomConfiguration': {'EndOfMeetingReminder': {'Enabled': 'boolean',
'ReminderAtMinutes': ['integer'],
'ReminderType': 'ANNOUNCEMENT_TIME_CHECK '
'| '
'ANNOUNCEMENT_VARIABLE_TIME_LEFT '
'| '
'CHIME '
'| '
'KNOCK'},
'InstantBooking': {'DurationInMinutes': 'integer',
'Enabled': 'boolean'},
'RequireCheckIn': {'Enabled': 'boolean',
'ReleaseAfterMinutes': 'integer'},
'RoomUtilizationMetricsEnabled': 'boolean'}}
Updates an existing room profile by room profile ARN.
See also: AWS API Documentation
Request Syntax
client.update_profile(
ProfileArn='string',
ProfileName='string',
IsDefault=True|False,
Timezone='string',
Address='string',
DistanceUnit='METRIC'|'IMPERIAL',
TemperatureUnit='FAHRENHEIT'|'CELSIUS',
WakeWord='ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
Locale='string',
SetupModeDisabled=True|False,
MaxVolumeLimit=123,
PSTNEnabled=True|False,
MeetingRoomConfiguration={
'RoomUtilizationMetricsEnabled': True|False,
'EndOfMeetingReminder': {
'ReminderAtMinutes': [
123,
],
'ReminderType': 'ANNOUNCEMENT_TIME_CHECK'|'ANNOUNCEMENT_VARIABLE_TIME_LEFT'|'CHIME'|'KNOCK',
'Enabled': True|False
},
'InstantBooking': {
'DurationInMinutes': 123,
'Enabled': True|False
},
'RequireCheckIn': {
'ReleaseAfterMinutes': 123,
'Enabled': True|False
}
}
)
string
The ARN of the room profile to update. Required.
string
The updated name for the room profile.
boolean
Sets the profile as default if selected. If this is missing, no update is done to the default status.
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.
string
The updated locale for the room profile. (This is currently only available to a limited preview audience.)
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
The updated meeting room settings of a room profile.
RoomUtilizationMetricsEnabled (boolean) --
Whether room utilization metrics are enabled or not.
EndOfMeetingReminder (dict) --
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
ReminderAtMinutes (list) --
Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
(integer) --
ReminderType (string) --
The type of sound that users hear during the end of meeting reminder.
Enabled (boolean) --
Whether an end of meeting reminder is enabled or not.
InstantBooking (dict) --
Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.
DurationInMinutes (integer) --
Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
Enabled (boolean) --
Whether instant booking is enabled or not.
RequireCheckIn (dict) --
Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
ReleaseAfterMinutes (integer) --
Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
Enabled (boolean) --
Whether require check in is enabled or not.
dict
Response Syntax
{}
Response Structure
(dict) --