QuickSight / Client / search_apps

search_apps¶

QuickSight.Client.search_apps(**kwargs)¶

Searches for apps in an Amazon Web Services account using the specified filters. This operation is eventually consistent; the results might not reflect very recent updates. Results are paginated; use the NextToken parameter to retrieve additional results.

Request Syntax

response = client.search_apps(
    AwsAccountId='string',
    Filters=[
        {
            'Name': 'APP_ID'|'APP_NAME'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER',
            'Operator': 'StringEquals'|'StringLike',
            'Value': 'string'
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the apps to search.
Filters (list) –
[REQUIRED]

The filters to apply to the search.
- (dict) –
  
  A filter to apply when searching for apps.
  - Name (string) – [REQUIRED]
    
    The name of the filter attribute.
  - Operator (string) – [REQUIRED]
    
    The comparison operator for the filter.
  - Value (string) – [REQUIRED]
    
    The value to filter on.
MaxResults (integer) – The maximum number of results to return in a single request. Valid range is 1 to 100. If you don’t specify a value, the default is 20.
NextToken (string) – The token for the next set of results, or null if there are no more results.

Return type:

dict

Returns:

Response Syntax

{
    'AppSummaryList': [
        {
            'AppId': 'string',
            'Arn': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Visibility': 'PRIVATE'|'PUBLIC'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

(dict) –
- AppSummaryList (list) –
  
  A list of app summaries that match the search criteria.
  - (dict) –
    
    A summary of an app, including its identifier, name, and metadata.
    - AppId (string) –
      
      The ID of the app.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the app.
    - Name (string) –
      
      The display name of the app.
    - CreatedTime (datetime) –
      
      The time that the app was created.
    - LastUpdatedTime (datetime) –
      
      The time that the app was last updated.
    - Visibility (string) –
      
      The sharing status of the app: PUBLIC if the app is shared publicly, or PRIVATE if it is private.
- NextToken (string) –
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.AccessDeniedException