NetworkManager / Client / update_link

update_link#

NetworkManager.Client.update_link(**kwargs)#

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

Request Syntax

response = client.update_link(
    GlobalNetworkId='string',
    LinkId='string',
    Description='string',
    Type='string',
    Bandwidth={
        'UploadSpeed': 123,
        'DownloadSpeed': 123
    },
    Provider='string'
)

Parameters:

GlobalNetworkId (string) –
[REQUIRED]

The ID of the global network.
LinkId (string) –
[REQUIRED]

The ID of the link.
Description (string) –
A description of the link.

Constraints: Maximum length of 256 characters.
Type (string) –
The type of the link.

Constraints: Maximum length of 128 characters.
Bandwidth (dict) –
The upload and download speed in Mbps.
- UploadSpeed (integer) –
  
  Upload speed in Mbps.
- DownloadSpeed (integer) –
  
  Download speed in Mbps.
Provider (string) –
The provider of the link.

Constraints: Maximum length of 128 characters.

Return type:

dict

Returns:

Response Syntax

{
    'Link': {
        '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) –
- Link (dict) –
  
  Information about the 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.

Exceptions

NetworkManager.Client.exceptions.ValidationException
NetworkManager.Client.exceptions.ServiceQuotaExceededException
NetworkManager.Client.exceptions.AccessDeniedException
NetworkManager.Client.exceptions.ResourceNotFoundException
NetworkManager.Client.exceptions.ConflictException
NetworkManager.Client.exceptions.ThrottlingException
NetworkManager.Client.exceptions.InternalServerException