NetworkManager / Client / get_link_associations

get_link_associations

NetworkManager.Client.get_link_associations(**kwargs)

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

See also: AWS API Documentation

Request Syntax

response = client.get_link_associations(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• GlobalNetworkId (string) –

  [REQUIRED]

  The ID of the global network.

• DeviceId (string) – The ID of the device.

• LinkId (string) – The ID of the link.

• 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

{
    'LinkAssociations': [
        {
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • LinkAssociations (list) –

    The link associations.

    • (dict) –

      Describes the association between a device and a link.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • DeviceId (string) –

        The device ID for the link association.

      • LinkId (string) –

        The ID of the link.

      • LinkAssociationState (string) –

        The state of the association.

  • NextToken (string) –

    The token for the next page of results.

Exceptions

• NetworkManager.Client.exceptions.ValidationException

• NetworkManager.Client.exceptions.AccessDeniedException

• NetworkManager.Client.exceptions.ResourceNotFoundException

• NetworkManager.Client.exceptions.ThrottlingException

• NetworkManager.Client.exceptions.InternalServerException