getRecoveryGroupReadinessSummary method

Future<GetRecoveryGroupReadinessSummaryResponse> getRecoveryGroupReadinessSummary({
  1. required String recoveryGroupName,
  2. int? maxResults,
  3. String? nextToken,
})

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

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

Parameter recoveryGroupName : The name of a recovery group.

Parameter maxResults : The number of objects that you want to return with this call.

Parameter nextToken : The token that identifies which batch of results you want to see.

Implementation

Future<GetRecoveryGroupReadinessSummaryResponse>
    getRecoveryGroupReadinessSummary({
  required String recoveryGroupName,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/recoverygroupreadiness/${Uri.encodeComponent(recoveryGroupName)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetRecoveryGroupReadinessSummaryResponse.fromJson(response);
}