SendCommandRequest

public struct SendCommandRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

    Declaration

    Swift

    public let cloudWatchOutputConfig: CloudWatchOutputConfig?

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

    Declaration

    Swift

    public let comment: String?

  • The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.

    Declaration

    Swift

    public let documentHash: String?

  • Sha256 or Sha1. Sha1 hashes have been deprecated.

    Declaration

    Swift

    public let documentHashType: DocumentHashType?

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

    Declaration

    Swift

    public let documentName: String

  • 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”

    Declaration

    Swift

    public let documentVersion: String?

  • 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.

    Declaration

    Swift

    public let instanceIds: [String]?

  • (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.

    Declaration

    Swift

    public let maxConcurrency: String?

  • 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.

    Declaration

    Swift

    public let maxErrors: String?

  • Configurations for sending notifications.

    Declaration

    Swift

    public let notificationConfig: NotificationConfig?

  • The name of the S3 bucket where command execution responses should be stored.

    Declaration

    Swift

    public let outputS3BucketName: String?

  • The directory structure within the S3 bucket where the responses should be stored.

    Declaration

    Swift

    public let outputS3KeyPrefix: String?

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

    Declaration

    Swift

    public let outputS3Region: String?

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

    Declaration

    Swift

    public let parameters: [String : [String]]?

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

    Declaration

    Swift

    public let serviceRoleArn: String?

  • 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.

    Declaration

    Swift

    public let targets: [Target]?

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

    Declaration

    Swift

    public let timeoutSeconds: Int?

  • Undocumented

    Declaration

    Swift

    public init(cloudWatchOutputConfig: CloudWatchOutputConfig? = nil, comment: String? = nil, documentHash: String? = nil, documentHashType: DocumentHashType? = nil, documentName: String, documentVersion: String? = nil, instanceIds: [String]? = nil, maxConcurrency: String? = nil, maxErrors: String? = nil, notificationConfig: NotificationConfig? = nil, outputS3BucketName: String? = nil, outputS3KeyPrefix: String? = nil, outputS3Region: String? = nil, parameters: [String : [String]]? = nil, serviceRoleArn: String? = nil, targets: [Target]? = nil, timeoutSeconds: Int? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws