startOnDemandReplicationRun method

Future<StartOnDemandReplicationRunResponse> startOnDemandReplicationRun({ required String replicationJobId, String? description, })

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

May throw InvalidParameterException. May throw MissingRequiredParameterException. May throw UnauthorizedOperationException. May throw OperationNotPermittedException. May throw ReplicationRunLimitExceededException. May throw DryRunOperationException.

Parameter replicationJobId : The ID of the replication job.

Parameter description : The description of the replication run.

Implementation

Future<StartOnDemandReplicationRunResponse> startOnDemandReplicationRun({
  required String replicationJobId,
  String? description,
}) async {
  ArgumentError.checkNotNull(replicationJobId, 'replicationJobId');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSServerMigrationService_V2016_10_24.StartOnDemandReplicationRun'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'replicationJobId': replicationJobId,
      if (description != null) 'description': description,
    },
  );

  return StartOnDemandReplicationRunResponse.fromJson(jsonResponse.body);
}