describeGlobalNetworks method

Future<DescribeGlobalNetworksResponse> describeGlobalNetworks({ List<String>? globalNetworkIds, int? maxResults, String? nextToken, })

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

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

Parameter globalNetworkIds : The IDs of one or more global networks. The maximum is 10.

Parameter maxResults : The maximum number of results to return.

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

Implementation

Future<DescribeGlobalNetworksResponse> describeGlobalNetworks({
  List<String>? globalNetworkIds,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    500,
  );
  final $query = <String, List<String>>{
    if (globalNetworkIds != null) 'globalNetworkIds': globalNetworkIds,
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/global-networks',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeGlobalNetworksResponse.fromJson(response);
}