There are more AWS SDK examples available in the AWS Doc SDK Examples
Use StartAutomationExecution
with a CLI
The following code examples show how to use StartAutomationExecution
.
- CLI
-
- AWS CLI
-
Example 1: To execute an automation document
The following
start-automation-execution
example runs an Automation document.aws ssm start-automation-execution \ --document-name
"AWS-UpdateLinuxAmi"
\ --parameters"AutomationAssumeRole=arn:aws:iam::123456789012:role/SSMAutomationRole,SourceAmiId=ami-EXAMPLE,IamInstanceProfileName=EC2InstanceRole"
Output:
{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }
For more information, see Running an Automation Workflow Manually in the AWS Systems Manager User Guide.
Example 2: To run a shared automation document
The following
start-automation-execution
example runs a shared Automation document.aws ssm start-automation-execution \ --document-name
"arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument"
Output:
{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }
For more information, see Using shared SSM documents in the AWS Systems Manager User Guide.
-
For API details, see StartAutomationExecution
in AWS CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell
-
Example 1: This example runs a document specifying an Automation role, an AMI source ID, and an Amazon EC2 instance role.
Start-SSMAutomationExecution -DocumentName AWS-UpdateLinuxAmi -Parameter @{'AutomationAssumeRole'='arn:aws:iam::123456789012:role/SSMAutomationRole';'SourceAmiId'='ami-f173cc91';'InstanceIamRole'='EC2InstanceRole'}
Output:
3a532a4f-0382-11e7-9df7-6f11185f6dd1
-
For API details, see StartAutomationExecution in AWS Tools for PowerShell Cmdlet Reference.
-