Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_workflows

list_workflows(**kwargs)

Lists all of your workflows.

See also: AWS API Documentation

Request Syntax

response = client.list_workflows(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- Specifies the maximum number of workflows to return.
  • NextToken (string) -- ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Workflows': [
        {
            'WorkflowId': 'string',
            'Description': 'string',
            'Arn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

    • Workflows (list) --

      Returns the Arn , WorkflowId , and Description for each workflow.

      • (dict) --

        Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.

        • WorkflowId (string) --

          A unique identifier for the workflow.

        • Description (string) --

          Specifies the text description for the workflow.

        • Arn (string) --

          Specifies the unique Amazon Resource Name (ARN) for the workflow.

Exceptions

  • Transfer.Client.exceptions.ServiceUnavailableException
  • Transfer.Client.exceptions.InternalServiceError
  • Transfer.Client.exceptions.InvalidNextTokenException
  • Transfer.Client.exceptions.InvalidRequestException