Skip to content

Start Change Request Execution

ssm_start_change_request_execution R Documentation

Creates a change request for Change Manager

Description

Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.

Usage

ssm_start_change_request_execution(ScheduledTime, DocumentName,
  DocumentVersion, Parameters, ChangeRequestName, ClientToken,
  AutoApprove, Runbooks, Tags, ScheduledEndTime, ChangeDetails)

Arguments

ScheduledTime

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

DocumentName

[required] The name of the change template document to run during the runbook workflow.

DocumentVersion

The version of the change template document to run during the runbook workflow.

Parameters

A key-value map of parameters that match the declared parameters in the change template document.

ChangeRequestName

The name of the change request associated with the runbook workflow to be run.

ClientToken

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

AutoApprove

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in start_change_request_execution creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

Runbooks

[required] Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Tags

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

  • ⁠Key=Environment,Value=Production⁠

  • ⁠Key=Region,Value=us-east-2⁠

ScheduledEndTime

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

ChangeDetails

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

Value

A list with the following syntax: 

list(
  AutomationExecutionId = "string"
)

Request syntax

svc$start_change_request_execution(
  ScheduledTime = as.POSIXct(
    "2015-01-01"
  ),
  DocumentName = "string",
  DocumentVersion = "string",
  Parameters = list(
    list(
      "string"
    )
  ),
  ChangeRequestName = "string",
  ClientToken = "string",
  AutoApprove = TRUE|FALSE,
  Runbooks = list(
    list(
      DocumentName = "string",
      DocumentVersion = "string",
      Parameters = list(
        list(
          "string"
        )
      ),
      TargetParameterName = "string",
      Targets = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      TargetMaps = list(
        list(
          list(
            "string"
          )
        )
      ),
      MaxConcurrency = "string",
      MaxErrors = "string",
      TargetLocations = list(
        list(
          Accounts = list(
            "string"
          ),
          Regions = list(
            "string"
          ),
          TargetLocationMaxConcurrency = "string",
          TargetLocationMaxErrors = "string",
          ExecutionRoleName = "string",
          TargetLocationAlarmConfiguration = list(
            IgnorePollAlarmFailure = TRUE|FALSE,
            Alarms = list(
              list(
                Name = "string"
              )
            )
          )
        )
      )
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ScheduledEndTime = as.POSIXct(
    "2015-01-01"
  ),
  ChangeDetails = "string"
)