ssm/aws.sdk.kotlin.services.ssm.model/AutomationExecutionMetadata

AutomationExecutionMetadata

class AutomationExecutionMetadata

Details about a specific Automation execution.

Types

object Companion

Properties

alarmConfiguration

val alarmConfiguration: AlarmConfiguration?

The details for the CloudWatch alarm applied to your automation.

val associationId: String?

The ID of a State Manager association used in the Automation operation.

automationExecutionId

val automationExecutionId: String?

The execution ID.

automationExecutionStatus

val automationExecutionStatus: AutomationExecutionStatus?

The status of the execution.

automationSubtype

val automationSubtype: AutomationSubtype?

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

val automationType: AutomationType?

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

changeRequestName

val changeRequestName: String?

The name of the Change Manager change request.

val currentAction: String?

The action of the step that is currently running.

currentStepName

val currentStepName: String?

The name of the step that is currently running.

val documentName: String?

The name of the Automation runbook used during execution.

documentVersion

val documentVersion: String?

The document version used during the execution.

val executedBy: String?

The IAM role ARN of the user who ran the automation.

executionEndTime

val executionEndTime: Instant?

The time the execution finished. This isn't populated if the execution is still in progress.

executionStartTime

val executionStartTime: Instant?

The time the execution started.

val failureMessage: String?

The list of execution outputs as defined in the Automation runbook.

val logFile: String?

An S3 bucket where execution information is stored.

val maxConcurrency: String?

The MaxConcurrency value specified by the user when starting the automation.

val maxErrors: String?

The MaxErrors value specified by the user when starting the automation.

val mode: ExecutionMode?

The Automation execution mode.

val opsItemId: String?

The ID of an OpsItem that is created to represent a Change Manager change request.

val outputs: Map<String, List<String>>?

The list of execution outputs as defined in the Automation runbook.

parentAutomationExecutionId

val parentAutomationExecutionId: String?

The execution ID of the parent automation.

resolvedTargets

val resolvedTargets: ResolvedTargets?

A list of targets that resolved during the execution.

val runbooks: List<Runbook>?

Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

val scheduledTime: Instant?

The date and time the Automation operation is scheduled to start.

val target: String?

The list of execution outputs as defined in the Automation runbook.

val targetMaps: List<Map<String, List<String>>>?

The specified key-value mapping of document parameters to target resources.

targetParameterName

val targetParameterName: String?

The list of execution outputs as defined in the Automation runbook.

val targets: List<Target>?

The targets defined by the user when starting the automation.

triggeredAlarms

val triggeredAlarms: List<AlarmStateInformation>?

The CloudWatch alarm that was invoked by the automation.

Functions

inline fun copy(block: AutomationExecutionMetadata.Builder.() -> Unit = {}): AutomationExecutionMetadata

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String