listOutposts method

Future<ListOutpostsOutput> listOutposts({ List<String>? availabilityZoneFilter, List<String>? availabilityZoneIdFilter, List<String>? lifeCycleStatusFilter, int? maxResults, String? nextToken, })

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

May throw AccessDeniedException. May throw InternalServerException. May throw ValidationException.

Parameter availabilityZoneFilter : Filters the results by Availability Zone (for example, us-east-1a).

Parameter availabilityZoneIdFilter : Filters the results by AZ ID (for example, use1-az1).

Parameter lifeCycleStatusFilter : Filters the results by the lifecycle status.

Implementation

Future<ListOutpostsOutput> listOutposts({
  List<String>? availabilityZoneFilter,
  List<String>? availabilityZoneIdFilter,
  List<String>? lifeCycleStatusFilter,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (availabilityZoneFilter != null)
      'AvailabilityZoneFilter': availabilityZoneFilter,
    if (availabilityZoneIdFilter != null)
      'AvailabilityZoneIdFilter': availabilityZoneIdFilter,
    if (lifeCycleStatusFilter != null)
      'LifeCycleStatusFilter': lifeCycleStatusFilter,
    if (maxResults != null) 'MaxResults': [maxResults.toString()],
    if (nextToken != null) 'NextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/outposts',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListOutpostsOutput.fromJson(response);
}