Amazon QuickSight

Searchs for dashboards that belong to a user.

See also: AWS API Documentation

Request Syntax

client.search_dashboards(
    AwsAccountId='string',
    Filters=[
        {
            'Operator': 'StringEquals',
            'Name': 'QUICKSIGHT_USER',
            'Value': 'string'
        },
    ],
    NextToken='string',
    MaxResults=123
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

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

type Filters:

list

param Filters:

[REQUIRED]

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" } ]

• (dict) --

  A filter that you apply when searching for dashboards.

  • Operator (string) -- [REQUIRED]

    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": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to be returned per request.

rtype:

dict

returns:

Response Syntax

{
    'DashboardSummaryList': [
        {
            'Arn': 'string',
            'DashboardId': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'PublishedVersionNumber': 123,
            'LastPublishedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) --

  • DashboardSummaryList (list) --

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

    • (dict) --

      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 (datetime) --

        The time that this dashboard was created.

      • LastUpdatedTime (datetime) --

        The last time that this dashboard was updated.

      • PublishedVersionNumber (integer) --

        Published version number.

      • LastPublishedTime (datetime) --

        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.