QuickSight / Client / search_analyses

search_analyses#

QuickSight.Client.search_analyses(**kwargs)#

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

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_analyses(
    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'|'ANALYSIS_NAME',
            'Value': 'string'
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the analyses that you’re searching for.
Filters (list) –
[REQUIRED]

The structure for the search filters that you want to apply to your search.
- (dict) –
  
  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". 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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_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 analyses with that ARN listed as one of the analysis’ 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 analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
    - DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
    - DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses 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 analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
    - ANALYSIS_NAME: Any analyses 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". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
NextToken (string) – A pagination token that can be used in a subsequent request.
MaxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'AnalysisSummaryList': [
        {
            'Arn': 'string',
            'AnalysisId': 'string',
            'Name': 'string',
            'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

(dict) –
- AnalysisSummaryList (list) –
  
  Metadata describing the analyses that you searched for.
  - (dict) –
    
    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 Amazon QuickSight console.
    - Status (string) –
      
      The last known status for the analysis.
    - CreatedTime (datetime) –
      
      The time that the analysis was created.
    - LastUpdatedTime (datetime) –
      
      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 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