AWS API Changes

2019/08/20 - Alexa For Business - 4 updated api methods

Changes Adding support for optional locale input in CreateProfile and UpdateProfile APIs

CreateProfile (updated)

Link ¶
Changes (request)

{'Locale': 'string'}

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
)

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.

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.

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': {'Locale': 'string'}}

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,
        'AddressBookArn': 'string'
    }
}

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.
  - 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.

SearchProfiles (updated)

Link ¶
Changes (response)

{'Profiles': {'Locale': 'string'}}

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'
        },
    ]
)

type NextToken

string

param NextToken

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 .

type MaxResults

integer

param MaxResults

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.

type Filters

list

param Filters

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) --

type SortCriteria

list

param SortCriteria

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.

rtype

dict

returns

Response Syntax

{
    'Profiles': [
        {
            'ProfileArn': 'string',
            'ProfileName': 'string',
            'IsDefault': True|False,
            'Address': 'string',
            'Timezone': 'string',
            'DistanceUnit': 'METRIC'|'IMPERIAL',
            'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
            'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
            'Locale': 'string'
        },
    ],
    '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.
    - IsDefault (boolean) --
      
      Retrieves if the profile data is default or not.
    - 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.
    - Locale (string) --
      
      The locale 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.

UpdateProfile (updated)

Link ¶
Changes (request)

{'Locale': 'string'}

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
)

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.

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --