putSourceServerAction method

Future<SourceServerActionDocument> putSourceServerAction({
  1. required String actionID,
  2. required String actionName,
  3. required String documentIdentifier,
  4. required int order,
  5. required String sourceServerID,
  6. String? accountID,
  7. bool? active,
  8. ActionCategory? category,
  9. String? description,
  10. String? documentVersion,
  11. Map<String, SsmExternalParameter>? externalParameters,
  12. bool? mustSucceedForCutover,
  13. Map<String, List<SsmParameterStoreParameter>>? parameters,
  14. int? timeoutSeconds,
})

Put source server post migration custom action.

May throw ConflictException. May throw ResourceNotFoundException. May throw UninitializedAccountException. May throw ValidationException.

Parameter actionID : Source server post migration custom action ID.

Parameter actionName : Source server post migration custom action name.

Parameter documentIdentifier : Source server post migration custom action document identifier.

Parameter order : Source server post migration custom action order.

Parameter sourceServerID : Source server ID.

Parameter accountID : Source server post migration custom account ID.

Parameter active : Source server post migration custom action active status.

Parameter category : Source server post migration custom action category.

Parameter description : Source server post migration custom action description.

Parameter documentVersion : Source server post migration custom action document version.

Parameter externalParameters : Source server post migration custom action external parameters.

Parameter mustSucceedForCutover : Source server post migration custom action must succeed for cutover.

Parameter parameters : Source server post migration custom action parameters.

Parameter timeoutSeconds : Source server post migration custom action timeout in seconds.

Implementation

Future<SourceServerActionDocument> putSourceServerAction({
  required String actionID,
  required String actionName,
  required String documentIdentifier,
  required int order,
  required String sourceServerID,
  String? accountID,
  bool? active,
  ActionCategory? category,
  String? description,
  String? documentVersion,
  Map<String, SsmExternalParameter>? externalParameters,
  bool? mustSucceedForCutover,
  Map<String, List<SsmParameterStoreParameter>>? parameters,
  int? timeoutSeconds,
}) async {
  _s.validateNumRange(
    'order',
    order,
    1001,
    10000,
    isRequired: true,
  );
  _s.validateNumRange(
    'timeoutSeconds',
    timeoutSeconds,
    1,
    1152921504606846976,
  );
  final $payload = <String, dynamic>{
    'actionID': actionID,
    'actionName': actionName,
    'documentIdentifier': documentIdentifier,
    'order': order,
    'sourceServerID': sourceServerID,
    if (accountID != null) 'accountID': accountID,
    if (active != null) 'active': active,
    if (category != null) 'category': category.value,
    if (description != null) 'description': description,
    if (documentVersion != null) 'documentVersion': documentVersion,
    if (externalParameters != null) 'externalParameters': externalParameters,
    if (mustSucceedForCutover != null)
      'mustSucceedForCutover': mustSucceedForCutover,
    if (parameters != null) 'parameters': parameters,
    if (timeoutSeconds != null) 'timeoutSeconds': timeoutSeconds,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/PutSourceServerAction',
    exceptionFnMap: _exceptionFns,
  );
  return SourceServerActionDocument.fromJson(response);
}