Using shared SSM documents
When you share an AWS Systems Manager (SSM) document, the system generates an Amazon
Resource Name (ARN) and assigns it to the command. If you select and run a shared
document from the Systems Manager console, you don't see the ARN. However, if you want to run
a shared SSM document using a method other than the Systems Manager console, you must
specify the full ARN of the document for the DocumentName
request
parameter. You're shown the full ARN for an SSM document when you run the command
to list documents.
You aren't required to specify ARNs for AWS public documents (documents that
begin with AWS-*
) or documents that you own.
Use a shared SSM document (command
line)
To list all public SSM documents
- Linux & macOS
-
aws ssm list-documents \
--filters Key=Owner,Values=Public
- Windows
-
aws ssm list-documents ^
--filters Key=Owner,Values=Public
- PowerShell
-
$filter = New-Object Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter
$filter.Key = "Owner"
$filter.Values = "Public"
Get-SSMDocumentList `
-Filters @($filter)
To list private SSM documents that have been shared with
you
- Linux & macOS
-
aws ssm list-documents \
--filters Key=Owner,Values=Private
- Windows
-
aws ssm list-documents ^
--filters Key=Owner,Values=Private
- PowerShell
-
$filter = New-Object Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter
$filter.Key = "Owner"
$filter.Values = "Private"
Get-SSMDocumentList `
-Filters @($filter)
To list all SSM documents available to you
- Linux & macOS
-
aws ssm list-documents
- Windows
-
aws ssm list-documents
- PowerShell
-
Get-SSMDocumentList
To get information about an SSM document that has been
shared with you
- Linux & macOS
-
aws ssm describe-document \
--name arn:aws:ssm:us-east-2:12345678912:document/documentName
- Windows
-
aws ssm describe-document ^
--name arn:aws:ssm:us-east-2:12345678912:document/documentName
- PowerShell
-
Get-SSMDocumentDescription `
–Name arn:aws:ssm:us-east-2:12345678912:document/documentName
To run a shared SSM document
- Linux & macOS
-
aws ssm send-command \
--document-name arn:aws:ssm:us-east-2:12345678912:document/documentName
\
--instance-ids ID
- Windows
-
aws ssm send-command ^
--document-name arn:aws:ssm:us-east-2:12345678912:document/documentName
^
--instance-ids ID
- PowerShell
-
Send-SSMCommand `
–DocumentName arn:aws:ssm:us-east-2:12345678912:document/documentName
`
–InstanceIds ID