QuickSight / Client / list_flows

list_flows¶

QuickSight.Client.list_flows(**kwargs)¶

Lists flows in an Amazon Web Services account.

Request Syntax

response = client.list_flows(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the flow list that you are getting.
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) –
  
  A structure that contains all of the flows in your Amazon Web Services account. This structure provides basic information about the flows.
  - (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