NetworkManager / Client / update_connection

update_connection#

NetworkManager.Client.update_connection(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.update_connection(
    GlobalNetworkId='string',
    ConnectionId='string',
    LinkId='string',
    ConnectedLinkId='string',
    Description='string'
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • ConnectionId (string) –

    [REQUIRED]

    The ID of the connection.

  • LinkId (string) – The ID of the link for the first device in the connection.

  • ConnectedLinkId (string) – The ID of the link for the second device in the connection.

  • Description (string) –

    A description of the connection.

    Length Constraints: Maximum length of 256 characters.

Return type:

dict

Returns:

Response Syntax

{
    'Connection': {
        'ConnectionId': 'string',
        'ConnectionArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'ConnectedDeviceId': 'string',
        'LinkId': 'string',
        'ConnectedLinkId': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • Connection (dict) –

      Information about the connection.

      • ConnectionId (string) –

        The ID of the connection.

      • ConnectionArn (string) –

        The Amazon Resource Name (ARN) of the connection.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • DeviceId (string) –

        The ID of the first device in the connection.

      • ConnectedDeviceId (string) –

        The ID of the second device in the connection.

      • LinkId (string) –

        The ID of the link for the first device in the connection.

      • ConnectedLinkId (string) –

        The ID of the link for the second device in the connection.

      • Description (string) –

        The description of the connection.

      • CreatedAt (datetime) –

        The date and time that the connection was created.

      • State (string) –

        The state of the connection.

      • Tags (list) –

        The tags for the connection.

        • (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