SageMaker / Paginator / ListFlowDefinitions

ListFlowDefinitions#

class SageMaker.Paginator.ListFlowDefinitions#
paginator = client.get_paginator('list_flow_definitions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SageMaker.Client.list_flow_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'FlowDefinitionSummaries': [
        {
            'FlowDefinitionName': 'string',
            'FlowDefinitionArn': 'string',
            'FlowDefinitionStatus': 'Initializing'|'Active'|'Failed'|'Deleting',
            'CreationTime': datetime(2015, 1, 1),
            'FailureReason': '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 .