SageMaker / Client / list_flow_definitions

list_flow_definitions#

SageMaker.Client.list_flow_definitions(**kwargs)#

Returns information about the flow definitions in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_flow_definitions(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • CreationTimeAfter (datetime) – A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

  • CreationTimeBefore (datetime) – A filter that returns only flow definitions that were created before the specified timestamp.

  • SortOrder (string) – An optional value that specifies whether you want the results sorted in Ascending or Descending order.

  • NextToken (string) – A token to resume pagination.

  • MaxResults (integer) – The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

Return type:

dict

Returns:

Response Syntax

{
    'FlowDefinitionSummaries': [
        {
            'FlowDefinitionName': 'string',
            'FlowDefinitionArn': 'string',
            'FlowDefinitionStatus': 'Initializing'|'Active'|'Failed'|'Deleting',
            'CreationTime': datetime(2015, 1, 1),
            'FailureReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • FlowDefinitionSummaries (list) –

      An array of objects describing the flow definitions.

      • (dict) –

        Contains summary information about the flow definition.

        • FlowDefinitionName (string) –

          The name of the flow definition.

        • FlowDefinitionArn (string) –

          The Amazon Resource Name (ARN) of the flow definition.

        • FlowDefinitionStatus (string) –

          The status of the flow definition. Valid values:

        • CreationTime (datetime) –

          The timestamp when SageMaker created the flow definition.

        • FailureReason (string) –

          The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

    • NextToken (string) –

      A token to resume pagination.