Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetConnections

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

Request Syntax


GET /global-networks/globalNetworkId/connections?connectionIds=ConnectionIds&deviceId=DeviceId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConnectionIds

One or more connection IDs.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

DeviceId

The ID of the device.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

globalNetworkId

The ID of the global network.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

Required: Yes

MaxResults

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 500.

NextToken

The token for the next page of results.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\s\S]*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Connections": [ 
      { 
         "ConnectedDeviceId": "string",
         "ConnectedLinkId": "string",
         "ConnectionArn": "string",
         "ConnectionId": "string",
         "CreatedAt": number,
         "Description": "string",
         "DeviceId": "string",
         "GlobalNetworkId": "string",
         "LinkId": "string",
         "State": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Connections

Information about the connections.

Type: Array of Connection objects

NextToken

The token to use for the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\s\S]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

HTTP Status Code: 400