Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

search-dashboards

Description

Searchs for dashboards that belong to a user.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  search-dashboards
--aws-account-id <value>
--filters <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the user whose dashboards you're searching for.

--filters (list)

The filters to apply to the search. Currently, you can search only by user name. For example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Shorthand Syntax:

Operator=string,Name=string,Value=string ...

JSON Syntax:

[
  {
    "Operator": "StringEquals",
    "Name": "QUICKSIGHT_USER",
    "Value": "string"
  }
  ...
]

--next-token (string)

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

--max-results (integer)

The maximum number of results to be returned per request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

DashboardSummaryList -> (list)

The list of dashboards owned by the user specified in Filters in your request.

(structure)

Dashboard summary.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

DashboardId -> (string)

Dashboard ID.

Name -> (string)

A display name for the dashboard.

CreatedTime -> (timestamp)

The time that this dashboard was created.

LastUpdatedTime -> (timestamp)

The last time that this dashboard was updated.

PublishedVersionNumber -> (long)

Published version number.

LastPublishedTime -> (timestamp)

The last time that this dashboard was published.

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 AWS request ID for this operation.