sendCommand method

Future<SendCommandResult> sendCommand({ required String documentName, CloudWatchOutputConfig? cloudWatchOutputConfig, String? comment, String? documentHash, DocumentHashType? documentHashType, String? documentVersion, List<String>? instanceIds, String? maxConcurrency, String? maxErrors, NotificationConfig? notificationConfig, String? outputS3BucketName, String? outputS3KeyPrefix, String? outputS3Region, Map<String, List<String>>? parameters, String? serviceRoleArn, List<Target>? targets, int? timeoutSeconds, })

Runs commands on one or more managed instances.

May throw DuplicateInstanceId. May throw InternalServerError. May throw InvalidInstanceId. May throw InvalidDocument. May throw InvalidDocumentVersion. May throw InvalidOutputFolder. May throw InvalidParameters. May throw UnsupportedPlatformType. May throw MaxDocumentSizeExceeded. May throw InvalidRole. May throw InvalidNotificationConfig.

Parameter documentName : Required. The name of the Systems Manager document to run. This can be a public document or a custom document.

Parameter cloudWatchOutputConfig : Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

Parameter comment : User-specified information about the command, such as a brief description of what the command should do.

Parameter documentHash : The Sha256 or Sha1 hash created by the system when the document was created.

Parameter documentHashType : Sha256 or Sha1.

Parameter documentVersion : The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "$DEFAULT"

--document-version "$LATEST"

--document-version "3"

Parameter instanceIds : The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.

Parameter maxConcurrency : (Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the AWS Systems Manager User Guide.

Parameter maxErrors : The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the AWS Systems Manager User Guide.

Parameter notificationConfig : Configurations for sending notifications.

Parameter outputS3BucketName : The name of the S3 bucket where command execution responses should be stored.

Parameter outputS3KeyPrefix : The directory structure within the S3 bucket where the responses should be stored.

Parameter outputS3Region : (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.

Parameter parameters : The required and optional parameters specified in the document being run.

Parameter serviceRoleArn : The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Parameter targets : An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the AWS Systems Manager User Guide.

Parameter timeoutSeconds : If this time is reached and the command has not already started running, it will not run.

Implementation

Future<SendCommandResult> sendCommand({
  required String documentName,
  CloudWatchOutputConfig? cloudWatchOutputConfig,
  String? comment,
  String? documentHash,
  DocumentHashType? documentHashType,
  String? documentVersion,
  List<String>? instanceIds,
  String? maxConcurrency,
  String? maxErrors,
  NotificationConfig? notificationConfig,
  String? outputS3BucketName,
  String? outputS3KeyPrefix,
  String? outputS3Region,
  Map<String, List<String>>? parameters,
  String? serviceRoleArn,
  List<Target>? targets,
  int? timeoutSeconds,
}) async {
  ArgumentError.checkNotNull(documentName, 'documentName');
  _s.validateStringLength(
    'comment',
    comment,
    0,
    100,
  );
  _s.validateStringLength(
    'documentHash',
    documentHash,
    0,
    256,
  );
  _s.validateStringLength(
    'maxConcurrency',
    maxConcurrency,
    1,
    7,
  );
  _s.validateStringLength(
    'maxErrors',
    maxErrors,
    1,
    7,
  );
  _s.validateStringLength(
    'outputS3BucketName',
    outputS3BucketName,
    3,
    63,
  );
  _s.validateStringLength(
    'outputS3KeyPrefix',
    outputS3KeyPrefix,
    0,
    500,
  );
  _s.validateStringLength(
    'outputS3Region',
    outputS3Region,
    3,
    20,
  );
  _s.validateNumRange(
    'timeoutSeconds',
    timeoutSeconds,
    30,
    2592000,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.SendCommand'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DocumentName': documentName,
      if (cloudWatchOutputConfig != null)
        'CloudWatchOutputConfig': cloudWatchOutputConfig,
      if (comment != null) 'Comment': comment,
      if (documentHash != null) 'DocumentHash': documentHash,
      if (documentHashType != null)
        'DocumentHashType': documentHashType.toValue(),
      if (documentVersion != null) 'DocumentVersion': documentVersion,
      if (instanceIds != null) 'InstanceIds': instanceIds,
      if (maxConcurrency != null) 'MaxConcurrency': maxConcurrency,
      if (maxErrors != null) 'MaxErrors': maxErrors,
      if (notificationConfig != null)
        'NotificationConfig': notificationConfig,
      if (outputS3BucketName != null)
        'OutputS3BucketName': outputS3BucketName,
      if (outputS3KeyPrefix != null) 'OutputS3KeyPrefix': outputS3KeyPrefix,
      if (outputS3Region != null) 'OutputS3Region': outputS3Region,
      if (parameters != null) 'Parameters': parameters,
      if (serviceRoleArn != null) 'ServiceRoleArn': serviceRoleArn,
      if (targets != null) 'Targets': targets,
      if (timeoutSeconds != null) 'TimeoutSeconds': timeoutSeconds,
    },
  );

  return SendCommandResult.fromJson(jsonResponse.body);
}