describeDomainChangeProgress method

Future<DescribeDomainChangeProgressResponse> describeDomainChangeProgress({ required String domainName, String? changeId, })

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

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

Parameter domainName : The domain you want to get the progress information about.

Parameter changeId : The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

Implementation

Future<DescribeDomainChangeProgressResponse> describeDomainChangeProgress({
  required String domainName,
  String? changeId,
}) async {
  ArgumentError.checkNotNull(domainName, 'domainName');
  _s.validateStringLength(
    'domainName',
    domainName,
    3,
    28,
    isRequired: true,
  );
  _s.validateStringLength(
    'changeId',
    changeId,
    36,
    36,
  );
  final $query = <String, List<String>>{
    if (changeId != null) 'changeid': [changeId],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/2021-01-01/opensearch/domain/${Uri.encodeComponent(domainName)}/progress',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeDomainChangeProgressResponse.fromJson(response);
}