QuickSight / Client / search_dashboards

search_dashboards#

QuickSight.Client.search_dashboards(**kwargs)#

Searches for dashboards that belong to a user.

Note

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Request Syntax

response = client.search_dashboards(
    AwsAccountId='string',
    Filters=[
        {
            'Operator': 'StringEquals'|'StringLike',
            'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DASHBOARD_NAME',
            'Value': 'string'
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the user whose dashboards you’re searching for.
Filters (list) –
[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". Valid values are "StringEquals" and "StringLike".
    
    If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
    
    If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.
  - Name (string) –
    
    The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".
    
    Valid values are defined as follows:
    - QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards’s owners or viewers are returned. Implicit permissions from folders or groups are considered.
    - QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.
    - DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.
    - DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered.
    - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.
    - DASHBOARD_NAME: Any dashboards whose names have a substring match to this value will be returned.
  - 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".
NextToken (string) – The token for the next set of results, or null if there are no more results.
MaxResults (integer) – The maximum number of results to be returned per request.

Return type:

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 Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.InvalidNextTokenException
QuickSight.Client.exceptions.InternalFailureException