NetworkManager / Client / get_links

get_links#

NetworkManager.Client.get_links(**kwargs)#

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

Request Syntax

response = client.get_links(
    GlobalNetworkId='string',
    LinkIds=[
        'string',
    ],
    SiteId='string',
    Type='string',
    Provider='string',
    MaxResults=123,
    NextToken='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.
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.

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'
                },
            ]
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  The token for the next page of results.

get_links#

Request Syntax

Response Syntax

Response Structure

Exceptions