aws ssm start-change-request-execution
Creates a change request for Change Manager. The runbooks (Automation documents) specified in the change request run only after all required approvals for the change request have been received
Options
Name | Description |
---|---|
--scheduled-time <timestamp> | 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 |
--document-name <string> | The name of the change template document to run during the runbook workflow |
--document-version <string> | The version of the change template document to run during the runbook workflow |
--parameters <map> | A key-value map of parameters that match the declared parameters in the change template document |
--change-request-name <string> | The name of the change request associated with the runbook workflow to be run |
--client-token <string> | The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused |
--runbooks <list> | Information about the Automation runbooks (Automation documents) 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 <list> | 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 AWS Region. In this case, you could specify the following key-value pairs: Key=Environment,Value=Production Key=Region,Value=us-east-2 |
--scheduled-end-time <timestamp> | 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 |
--change-details <string> | 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 |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |