syncDeploymentJob method

Future<SyncDeploymentJobResponse> syncDeploymentJob({ required String fleet, String? clientRequestToken, })

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw InternalServerException. May throw ThrottlingException. May throw LimitExceededException. May throw ConcurrentDeploymentException. May throw IdempotentParameterMismatchException.

Parameter fleet : The target fleet for the synchronization.

Parameter clientRequestToken : Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Implementation

Future<SyncDeploymentJobResponse> syncDeploymentJob({
  required String fleet,
  String? clientRequestToken,
}) async {
  ArgumentError.checkNotNull(fleet, 'fleet');
  _s.validateStringLength(
    'fleet',
    fleet,
    1,
    1224,
    isRequired: true,
  );
  _s.validateStringLength(
    'clientRequestToken',
    clientRequestToken,
    1,
    64,
  );
  final $payload = <String, dynamic>{
    'fleet': fleet,
    'clientRequestToken': clientRequestToken ?? _s.generateIdempotencyToken(),
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/syncDeploymentJob',
    exceptionFnMap: _exceptionFns,
  );
  return SyncDeploymentJobResponse.fromJson(response);
}