/AWS1/CL_SSM=>STARTCHANGEREQUESTEXECUTION()
¶
About StartChangeRequestExecution¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DOCUMENTNAME
TYPE /AWS1/SSMDOCUMENTARN
/AWS1/SSMDOCUMENTARN
¶
The name of the change template document to run during the runbook workflow.
IT_RUNBOOKS
TYPE /AWS1/CL_SSMRUNBOOK=>TT_RUNBOOKS
TT_RUNBOOKS
¶
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.
Optional arguments:¶
IV_SCHEDULEDTIME
TYPE /AWS1/SSMDATETIME
/AWS1/SSMDATETIME
¶
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.
IV_DOCUMENTVERSION
TYPE /AWS1/SSMDOCUMENTVERSION
/AWS1/SSMDOCUMENTVERSION
¶
The version of the change template document to run during the runbook workflow.
IT_PARAMETERS
TYPE /AWS1/CL_SSMAUTOMATIONPRMVAL00=>TT_AUTOMATIONPARAMETERMAP
TT_AUTOMATIONPARAMETERMAP
¶
A key-value map of parameters that match the declared parameters in the change template document.
IV_CHANGEREQUESTNAME
TYPE /AWS1/SSMCHANGEREQUESTNAME
/AWS1/SSMCHANGEREQUESTNAME
¶
The name of the change request associated with the runbook workflow to be run.
IV_CLIENTTOKEN
TYPE /AWS1/SSMIDEMPOTENCYTOKEN
/AWS1/SSMIDEMPOTENCYTOKEN
¶
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
IV_AUTOAPPROVE
TYPE /AWS1/SSMBOOLEAN
/AWS1/SSMBOOLEAN
¶
Indicates whether the change request can be approved automatically without the need for manual approvals.
If
AutoApprovable
is enabled in a change template, then settingAutoApprove
totrue
inStartChangeRequestExecution
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 againOPEN
.
IT_TAGS
TYPE /AWS1/CL_SSMTAG=>TT_TAGLIST
TT_TAGLIST
¶
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
IV_SCHEDULEDENDTIME
TYPE /AWS1/SSMDATETIME
/AWS1/SSMDATETIME
¶
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.
IV_CHANGEDETAILS
TYPE /AWS1/SSMCHANGEDETAILSVALUE
/AWS1/SSMCHANGEDETAILSVALUE
¶
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.