Private5G / Paginator / ListNetworks

ListNetworks

class Private5G.Paginator.ListNetworks

paginator = client.get_paginator('list_networks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Private5G.Client.list_networks().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• filters (dict) –

  The filters.

  • STATUS - The status ( AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

  Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • (string) –

    • (list) –

      • (string) –

• 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

{
    'networks': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'networkArn': 'string',
            'networkName': 'string',
            'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
            'statusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • networks (list) –

    The networks.

    • (dict) –

      Information about a network.

      • createdAt (datetime) –

        The creation time of the network.

      • description (string) –

        The description of the network.

      • networkArn (string) –

        The Amazon Resource Name (ARN) of the network.

      • networkName (string) –

        The name of the network.

      • status (string) –

        The status of the network.

      • statusReason (string) –

        The status reason of the network.

  • NextToken (string) –

    A token to resume pagination.