ssm_start_change_request_execution: Creates a change request for Change Manager

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

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.

Usage

1
2
3
ssm_start_change_request_execution(ScheduledTime, DocumentName,
  DocumentVersion, Parameters, ChangeRequestName, ClientToken, Runbooks,
  Tags)

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.

Runbooks

[required] 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

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

Value

A list with the following syntax:

1
2
3
list(
  AutomationExecutionId = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
svc$start_change_request_execution(
  ScheduledTime = as.POSIXct(
    "2015-01-01"
  ),
  DocumentName = "string",
  DocumentVersion = "string",
  Parameters = list(
    list(
      "string"
    )
  ),
  ChangeRequestName = "string",
  ClientToken = "string",
  Runbooks = list(
    list(
      DocumentName = "string",
      DocumentVersion = "string",
      Parameters = list(
        list(
          "string"
        )
      ),
      TargetParameterName = "string",
      Targets = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      MaxConcurrency = "string",
      MaxErrors = "string",
      TargetLocations = list(
        list(
          Accounts = list(
            "string"
          ),
          Regions = list(
            "string"
          ),
          TargetLocationMaxConcurrency = "string",
          TargetLocationMaxErrors = "string",
          ExecutionRoleName = "string"
        )
      )
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.