[ aws . quicksight ]

search-analyses

Description

Searches for analyses that belong to the user specified in the filter.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--aws-account-id (string)

The ID of the AWS account that contains the analyses that you’re searching for.

--filters (list)

The structure for the search filters that you want to apply to your search.

(structure)

A filter that you apply when searching for one or more analyses.

Operator -> (string)

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" .

Name -> (string)

The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_USER" .

Value -> (string)

The value of the named item, in this case QUICKSIGHT_USER , that you want to use as a filter, for example "Value" . An example is "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)

A pagination token that can be used in a subsequent request.

--max-results (integer)

The maximum number of results to return.

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

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

AnalysisSummaryList -> (list)

Metadata describing the analyses that you searched for.

(structure)

The summary metadata that describes an analysis.

Arn -> (string)

The Amazon Resource Name (ARN) for the analysis.

AnalysisId -> (string)

The ID of the analysis. This ID displays in the URL.

Name -> (string)

The name of the analysis. This name is displayed in the QuickSight console.

Status -> (string)

The last known status for the analysis.

CreatedTime -> (timestamp)

The time that the analysis was created.

LastUpdatedTime -> (timestamp)

The time that the analysis was last updated.

NextToken -> (string)

A pagination token that can be used in a subsequent request.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The AWS request ID for this operation.