[ aws . quicksight ]

list-themes

Description

Lists all the themes in the current Amazon Web Services account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-themes 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: ThemeSummaryList

Synopsis

  list-themes
--aws-account-id <value>
[--type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the Amazon Web Services account that contains the themes that you’re listing.

--type (string)

The type of themes that you want to list. Valid options include the following:

• ALL (default) - Display all existing themes.

• CUSTOM - Display only the themes created by people using Amazon QuickSight.

• QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.

Possible values:

• QUICKSIGHT

• CUSTOM

• ALL

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

See ‘aws help’ for descriptions of global parameters.

Output

ThemeSummaryList -> (list)

Information about the themes in the list.

(structure)

The theme summary.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

Name -> (string)

the display name for the theme.

ThemeId -> (string)

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

LatestVersionNumber -> (long)

The latest version number for the theme.

CreatedTime -> (timestamp)

The date and time that this theme was created.

LastUpdatedTime -> (timestamp)

The last date and time that this theme was updated.

NextToken -> (string)

The token for the next set of results, or null if there are no more results.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.