AWS API Changes

2021/03/25 - Alexa For Business - 3 updated api methods

Changes Added support for enabling and disabling data retention in the CreateProfile and UpdateProfile APIs and retrieving the state of data retention for a profile in the GetProfile API.

CreateProfile (updated)

Link ¶
Changes (request)

{'DataRetentionOptIn': '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,
    DataRetentionOptIn=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
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ProfileName

string

param ProfileName

[REQUIRED]

The name of a room profile.

type Timezone

string

param Timezone

[REQUIRED]

The time zone used by a room profile.

type Address

string

param Address

[REQUIRED]

The valid address for the room.

type DistanceUnit

string

param DistanceUnit

[REQUIRED]

The distance unit to be used by devices in the profile.

type TemperatureUnit

string

param TemperatureUnit

[REQUIRED]

The temperature unit to be used by devices in the profile.

type WakeWord

string

param WakeWord

[REQUIRED]

A wake word for Alexa, Echo, Amazon, or a computer.

type Locale

string

param Locale

The locale of the room profile. (This is currently only available to a limited preview audience.)

type ClientRequestToken

string

param ClientRequestToken

The user-specified token that is used during the creation of a profile.

This field is autopopulated if not provided.

type SetupModeDisabled

boolean

param SetupModeDisabled

Whether room profile setup is enabled.

type MaxVolumeLimit

integer

param MaxVolumeLimit

The maximum volume limit for a room profile.

type PSTNEnabled

boolean

param PSTNEnabled

Whether PSTN calling is enabled.

type DataRetentionOptIn

boolean

param DataRetentionOptIn

Whether data retention of the profile is enabled.

type MeetingRoomConfiguration

dict

param MeetingRoomConfiguration

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.

type Tags

list

param Tags

The tags for the profile.

(dict) --

A key-value pair that can be associated with a resource.
- Key (string) -- [REQUIRED]
  
  The key of a tag. Tag keys are case-sensitive.
- Value (string) -- [REQUIRED]
  
  The value of a tag. Tag values are case sensitive and can be null.

rtype

dict

returns

Response Syntax

{
    'ProfileArn': 'string'
}

Response Structure

(dict) --
- ProfileArn (string) --
  
  The ARN of the newly created room profile in the response.

GetProfile (updated)

Link ¶
Changes (response)

{'Profile': {'DataRetentionOptIn': 'boolean'}}

Gets the details of a room profile by profile ARN.

See also: AWS API Documentation

Request Syntax

client.get_profile(
    ProfileArn='string'
)

type ProfileArn

string

param ProfileArn

The ARN of the room profile for which to request details. Required.

rtype

dict

returns

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,
        'DataRetentionOptIn': 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.
  - DataRetentionOptIn (boolean) --
    
    Whether data retention of the profile is enabled.
  - 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.

UpdateProfile (updated)

Link ¶
Changes (request)

{'DataRetentionOptIn': '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,
    DataRetentionOptIn=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
        }
    }
)

type ProfileArn

string

param ProfileArn

The ARN of the room profile to update. Required.

type ProfileName

string

param ProfileName

The updated name for the room profile.

type IsDefault

boolean

param IsDefault

Sets the profile as default if selected. If this is missing, no update is done to the default status.

type Timezone

string

param Timezone

The updated timezone for the room profile.

type Address

string

param Address

The updated address for the room profile.

type DistanceUnit

string

param DistanceUnit

The updated distance unit for the room profile.

type TemperatureUnit

string

param TemperatureUnit

The updated temperature unit for the room profile.

type WakeWord

string

param WakeWord

The updated wake word for the room profile.

type Locale

string

param Locale

The updated locale for the room profile. (This is currently only available to a limited preview audience.)

type SetupModeDisabled

boolean

param SetupModeDisabled

Whether the setup mode of the profile is enabled.

type MaxVolumeLimit

integer

param MaxVolumeLimit

The updated maximum volume limit for the room profile.

type PSTNEnabled

boolean

param PSTNEnabled

Whether the PSTN setting of the room profile is enabled.

type DataRetentionOptIn

boolean

param DataRetentionOptIn

Whether data retention of the profile is enabled.

type MeetingRoomConfiguration

dict

param MeetingRoomConfiguration

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --