QuickSight / Client / search_flows

search_flows

QuickSight.Client.search_flows(**kwargs)

Search for the flows in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account where you are searching for flows from.

• Filters (list) –

  [REQUIRED]

  The filters applied to the search when searching for flows in the Amazon Web Services account.

  • (dict) –

    A structure that contains the filter information when searching flows.

    • Name (string) – [REQUIRED]

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

      Valid values are defined as follows:

      • assetName: Any flows whose names have a substring match to this value will be returned.

      • assetDescription: Any flows whose descriptions have a substring match to this value will be returned.

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

    • Operator (string) – [REQUIRED]

      The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

    • Value (string) – [REQUIRED]

      The value of the named item, in this case DIRECT_QUICKSIGHT_SOLE_OWNER, 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) – The token to request the next set of results, or null if you want to retrieve the first set.

• MaxResults (integer) – The maximum number of results to be returned per request.

Return type:

dict

Returns:

Response Syntax

{
    'FlowSummaryList': [
        {
            'Arn': 'string',
            'FlowId': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'LastUpdatedBy': 'string',
            'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
            'RunCount': 123,
            'UserCount': 123,
            'LastPublishedBy': 'string',
            'LastPublishedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • FlowSummaryList (list) –

    The list of flows found against the search.

    • (dict) –

      The basic information of the flow exluding its definition specifying the steps.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the flow.

      • FlowId (string) –

        The unique identifier of the flow.

      • Name (string) –

        The display name of the flow.

      • Description (string) –

        The description of the flow.

      • CreatedTime (datetime) –

        The time this flow was created.

      • CreatedBy (string) –

        The identifier of the principal who created the flow.

      • LastUpdatedTime (datetime) –

        The last time this flow was modified.

      • LastUpdatedBy (string) –

        The identifier of the last principal who updated the flow.

      • PublishState (string) –

        The publish state for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

      • RunCount (integer) –

        The number of runs done for the flow.

      • UserCount (integer) –

        The number of users who have used the flow.

      • LastPublishedBy (string) –

        The identifier of the last principal who published the flow.

      • LastPublishedAt (datetime) –

        The last time this flow was published.

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

  • Status (integer) –

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.InternalFailureException

• QuickSight.Client.exceptions.AccessDeniedException