[ aws . alexaforbusiness ]

search-profiles

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

search-profiles is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Profiles

Synopsis

  search-profiles
[--filters <value>]
[--sort-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filters (list)

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

(structure)

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)

The key of a filter.

Values -> (list)

The values of a filter.

(string)

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--sort-criteria (list)

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

(structure)

An object representing a sort criteria.

Key -> (string)

The sort key of a sort object.

Value -> (string)

The sort value of a sort object.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "ASC"|"DESC"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Profiles -> (list)

The profiles that meet the specified set of filter criteria, in sort order.

(structure)

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.