MediaConnect / Paginator / ListFlows

ListFlows

class MediaConnect.Paginator.ListFlows

paginator = client.get_paginator('list_flows')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_flows().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'Flows': [
        {
            'AvailabilityZone': 'string',
            'Description': 'string',
            'FlowArn': 'string',
            'Name': 'string',
            'SourceType': 'OWNED'|'ENTITLED',
            'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
            'Maintenance': {
                'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
                'MaintenanceDeadline': 'string',
                'MaintenanceScheduledDate': 'string',
                'MaintenanceStartHour': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • Flows (list) –

    A list of flow summaries.

    • (dict) –

      A summary of a flow, including its ARN, Availability Zone, and source type.

      • AvailabilityZone (string) –

        The Availability Zone that the flow was created in.

      • Description (string) –

        A description of the flow.

      • FlowArn (string) –

        The ARN of the flow.

      • Name (string) –

        The name of the flow.

      • SourceType (string) –

        The type of source. This value is either owned (originated somewhere other than an MediaConnect flow owned by another Amazon Web Services account) or entitled (originated at a MediaConnect flow owned by another Amazon Web Services account).

      • Status (string) –

        The current status of the flow.

      • Maintenance (dict) –

        The maintenance settings for the flow.

        • MaintenanceDay (string) –

          A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.

        • MaintenanceDeadline (string) –

          The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.

        • MaintenanceScheduledDate (string) –

          A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.

        • MaintenanceStartHour (string) –

          UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.