describeDirectConnectGateways method

Future<DescribeDirectConnectGatewaysResult> describeDirectConnectGateways({ String? directConnectGatewayId, int? maxResults, String? nextToken, })

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

May throw DirectConnectServerException. May throw DirectConnectClientException.

Parameter directConnectGatewayId : The ID of the Direct Connect gateway.

Parameter maxResults : The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

Parameter nextToken : The token provided in the previous call to retrieve the next page.

Implementation

Future<DescribeDirectConnectGatewaysResult> describeDirectConnectGateways({
  String? directConnectGatewayId,
  int? maxResults,
  String? nextToken,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'OvertureService.DescribeDirectConnectGateways'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (directConnectGatewayId != null)
        'directConnectGatewayId': directConnectGatewayId,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return DescribeDirectConnectGatewaysResult.fromJson(jsonResponse.body);
}