Command

public struct Command : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • CloudWatch Logs information where you want Systems Manager to send the command output.

    Declaration

    Swift

    public let cloudWatchOutputConfig: CloudWatchOutputConfig?

  • A unique identifier for this command.

    Declaration

    Swift

    public let commandId: String?

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

    Declaration

    Swift

    public let comment: String?

  • The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

    Declaration

    Swift

    public let completedCount: Int?

  • The number of targets for which the status is Delivery Timed Out.

    Declaration

    Swift

    public let deliveryTimedOutCount: Int?

  • The name of the document requested for execution.

    Declaration

    Swift

    public let documentName: String?

  • The SSM document version.

    Declaration

    Swift

    public let documentVersion: String?

  • The number of targets for which the status is Failed or Execution Timed Out.

    Declaration

    Swift

    public let errorCount: Int?

  • If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

    Declaration

    Swift

    public let expiresAfter: TimeStamp?

  • The instance IDs against which this command was requested.

    Declaration

    Swift

    public let instanceIds: [String]?

  • The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

    Declaration

    Swift

    public let maxConcurrency: String?

  • The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

    Declaration

    Swift

    public let maxErrors: String?

  • Configurations for sending notifications about command status changes.

    Declaration

    Swift

    public let notificationConfig: NotificationConfig?

  • The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

    Declaration

    Swift

    public let outputS3BucketName: String?

  • The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

    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 parameter values to be inserted in the document when running the command.

    Declaration

    Swift

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

  • The date and time the command was requested.

    Declaration

    Swift

    public let requestedDateTime: TimeStamp?

  • The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

    Declaration

    Swift

    public let serviceRole: String?

  • The status of the command.

    Declaration

    Swift

    public let status: CommandStatus?

  • A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to any instances. In Progress: The command has been sent to at least one instance but has not reached a final state on all instances. Success: The command successfully ran on all invocations. This is a terminal state. Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state. Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state. Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

    Declaration

    Swift

    public let statusDetails: String?

  • The number of targets for the command.

    Declaration

    Swift

    public let targetCount: Int?

  • An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don’t provide one or more instance IDs in the call.

    Declaration

    Swift

    public let targets: [Target]?

  • The TimeoutSeconds value specified for a command.

    Declaration

    Swift

    public let timeoutSeconds: Int?

  • Undocumented

    Declaration

    Swift

    public init(cloudWatchOutputConfig: CloudWatchOutputConfig? = nil, commandId: String? = nil, comment: String? = nil, completedCount: Int? = nil, deliveryTimedOutCount: Int? = nil, documentName: String? = nil, documentVersion: String? = nil, errorCount: Int? = nil, expiresAfter: TimeStamp? = 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, requestedDateTime: TimeStamp? = nil, serviceRole: String? = nil, status: CommandStatus? = nil, statusDetails: String? = nil, targetCount: Int? = nil, targets: [Target]? = nil, timeoutSeconds: Int? = nil)