listPlatformBranches method

Future<ListPlatformBranchesResult> listPlatformBranches({
  1. List<SearchFilter>? filters,
  2. int? maxRecords,
  3. String? nextToken,
})

Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Parameter filters : Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

  • Attribute = BranchName:
    • Operator: = | != | begins_with | ends_with | contains | in | not_in
  • Attribute = LifecycleState:
    • Operator: = | != | in | not_in
    • Values: beta | supported | deprecated | retired
  • Attribute = PlatformName:
    • Operator: = | != | begins_with | ends_with | contains | in | not_in
  • Attribute = TierType:
    • Operator: = | !=
    • Values: WebServer/Standard | Worker/SQS/HTTP
Array size: limited to 10 SearchFilter objects.

Within each SearchFilter item, the Values array is limited to 10 items.

Parameter maxRecords : The maximum number of platform branch values returned in one call.

Parameter nextToken : For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Implementation

Future<ListPlatformBranchesResult> listPlatformBranches({
  List<SearchFilter>? filters,
  int? maxRecords,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxRecords',
    maxRecords,
    1,
    1152921504606846976,
  );
  final $request = <String, dynamic>{};
  filters?.also((arg) => $request['Filters'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListPlatformBranches',
    version: '2010-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListPlatformBranchesRequest'],
    shapes: shapes,
    resultWrapper: 'ListPlatformBranchesResult',
  );
  return ListPlatformBranchesResult.fromXml($result);
}