getConnections method

Future<GetConnectionsResponse> getConnections({ required String globalNetworkId, List<String>? connectionIds, String? deviceId, int? maxResults, String? nextToken, })

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

May throw ValidationException. May throw AccessDeniedException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw InternalServerException.

Parameter globalNetworkId : The ID of the global network.

Parameter connectionIds : One or more connection IDs.

Parameter deviceId : The ID of the device.

Parameter maxResults : The maximum number of results to return.

Parameter nextToken : The token for the next page of results.

Implementation

Future<GetConnectionsResponse> getConnections({
  required String globalNetworkId,
  List<String>? connectionIds,
  String? deviceId,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(globalNetworkId, 'globalNetworkId');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    500,
  );
  final $query = <String, List<String>>{
    if (connectionIds != null) 'connectionIds': connectionIds,
    if (deviceId != null) 'deviceId': [deviceId],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/global-networks/${Uri.encodeComponent(globalNetworkId)}/connections',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetConnectionsResponse.fromJson(response);
}