describeOutboundConnections method

Future<DescribeOutboundConnectionsResponse> describeOutboundConnections({ List<Filter>? filters, int? maxResults, String? nextToken, })

Lists all the outbound cross-cluster connections for a local domain.

May throw InvalidPaginationTokenException. May throw DisabledOperationException.

Parameter filters : A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are:

• connection-id
• remote-domain-info.domain-name
• remote-domain-info.owner-id
• remote-domain-info.region
• local-domain-info.domain-name

Parameter maxResults : Set this value to limit the number of results returned. If not specified, defaults to 100.

Parameter nextToken : NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.

Implementation

Future<DescribeOutboundConnectionsResponse> describeOutboundConnections({
  List<Filter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    0,
    100,
  );
  final $payload = <String, dynamic>{
    if (filters != null) 'Filters': filters,
    if (maxResults != null) 'MaxResults': maxResults,
    if (nextToken != null) 'NextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/2021-01-01/opensearch/cc/outboundConnection/search',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeOutboundConnectionsResponse.fromJson(response);
}