NetworkManager / Paginator / GetLinks

GetLinks

class NetworkManager.Paginator.GetLinks

paginator = client.get_paginator('get_links')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_links().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    LinkIds=[
        'string',
    ],
    SiteId='string',
    Type='string',
    Provider='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GlobalNetworkId (string) –

  [REQUIRED]

  The ID of the global network.

• LinkIds (list) –

  One or more link IDs. The maximum is 10.

  • (string) –

• SiteId (string) – The ID of the site.

• Type (string) – The link type.

• Provider (string) – The link provider.

• 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

{
    'Links': [
        {
            'LinkId': 'string',
            'LinkArn': 'string',
            'GlobalNetworkId': 'string',
            'SiteId': 'string',
            'Description': 'string',
            'Type': 'string',
            'Bandwidth': {
                'UploadSpeed': 123,
                'DownloadSpeed': 123
            },
            'Provider': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • Links (list) –

    The links.

    • (dict) –

      Describes a link.

      • LinkId (string) –

        The ID of the link.

      • LinkArn (string) –

        The Amazon Resource Name (ARN) of the link.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • SiteId (string) –

        The ID of the site.

      • Description (string) –

        The description of the link.

      • Type (string) –

        The type of the link.

      • Bandwidth (dict) –

        The bandwidth for the link.

        • UploadSpeed (integer) –

          Upload speed in Mbps.

        • DownloadSpeed (integer) –

          Download speed in Mbps.

      • Provider (string) –

        The provider of the link.

      • CreatedAt (datetime) –

        The date and time that the link was created.

      • State (string) –

        The state of the link.

      • Tags (list) –

        The tags for the link.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) –

            The tag value.

            Constraints: Maximum length of 256 characters.