get_connections

get_connections(**kwargs)

Gets information about one or more of your connections in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_connections(
    GlobalNetworkId='string',
    ConnectionIds=[
        'string',
    ],
    DeviceId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• GlobalNetworkId (string) --

  [REQUIRED]

  The ID of the global network.

• ConnectionIds (list) --

  One or more connection IDs.

  • (string) --
• DeviceId (string) -- The ID of the device.
• 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

{
    'Connections': [
        {
            '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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Connections (list) --

    Information about the connections.

    • (dict) --

      Describes a 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.

  • NextToken (string) --

    The token to use 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