AlexaForBusiness / Client / search_profiles

search_profiles#

AlexaForBusiness.Client.search_profiles(**kwargs)#

Searches room profiles and lists the ones that meet a set of filter criteria.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.search_profiles(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ]
)

Parameters:

NextToken (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.
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.
Filters (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) –
SortCriteria (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.

Return type:

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 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.)
- NextToken (string) –
  
  The token returned to indicate that there is more data available.
- TotalCount (integer) –
  
  The total number of room profiles returned.