describePackages method

Future<DescribePackagesResponse> describePackages({ List<DescribePackagesFilter>? filters, int? maxResults, String? nextToken, })

Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.

May throw BaseException. May throw InternalException. May throw ResourceNotFoundException. May throw AccessDeniedException. May throw ValidationException.

Parameter filters : Only returns packages that match the DescribePackagesFilterList values.

Parameter maxResults : Limits results to a maximum number of packages.

Parameter nextToken : Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Implementation

Future<DescribePackagesResponse> describePackages({
  List<DescribePackagesFilter>? 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/packages/describe',
    exceptionFnMap: _exceptionFns,
  );
  return DescribePackagesResponse.fromJson(response);
}