Share a Systems Manager Document

You can share Systems Manager document by using the Amazon EC2 console, the AWS Systems Manager console, or by programmatically calling the ModifyDocumentPermission API operation using the AWS CLI, AWS Tools for Windows PowerShell, or the AWS SDK. Before you share a document, get the AWS account IDs of the people with whom you want to share. You will specify these account IDs when you share the document.

Topics

Share a Document (Console)
Share a Document (AWS CLI)
Share a Document (AWS Tools for Windows PowerShell)

Share a document

Open the AWS Systems Manager console at https://console.aws.amazon.com/systems-manager/.
In the navigation pane, choose Documents.

-or-

If the AWS Systems Manager home page opens first, choose the menu icon ( ) to open the navigation pane, and then choose Documents in the navigation pane.
In the documents list, choose the document you want to share, and then choose View details. On the Permissions tab, verify that you are the document owner. Only a document owner can share a document.
Choose Edit.
To share the command publicly, choose Public and then choose Save. To share the command privately, choose Private, enter the AWS account ID, choose Add permission, and then choose Save.

The following procedure requires that you specify a region for your CLI session. Run Command is currently available in the following Systems Manager regions.

Open the AWS CLI on your local computer and run the following command to specify your credentials.
```
aws config

AWS Access Key ID: [your key]
AWS Secret Access Key: [your key]
Default region name: region
Default output format [None]:
```
region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager Table of Regions and Endpoints in the AWS General Reference.
Use the following command to list all of the Systems Manager documents that are available for you. The list includes documents that you created and documents that were shared with you.
```
aws ssm list-documents --document-filter-list key=Owner,value=all
```
Use the following command to get a specific document.
```
aws ssm get-document --name document name
```
Use the following command to get a description of the document.
```
aws ssm describe-document --name document name
```
Use the following command to view the permissions for the document.
```
aws ssm describe-document-permission --name document name --permission-type Share
```
Use the following command to modify the permissions for the document and share it. You must be the owner of the document to edit the permissions. This command privately shares the document with a specific individual, based on that person's AWS account ID.
```
aws ssm modify-document-permission --name document name --permission-type Share --account-ids-to-add AWS account ID
```
Use the following command to share a document publicly.
```
aws ssm modify-document-permission --name document name --permission-type Share --account-ids-to-add 'all'
```

The following procedure requires that you specify a region for your PowerShell session. Run Command is currently available in the following Systems Manager regions.

Open AWS Tools for Windows PowerShell on your local computer and run the following command to specify your credentials.
```
Set-AWSCredentials –AccessKey your key –SecretKey your key
```
Use the following command to set the region for your PowerShell session. The example uses the us-west-2 region.
```
Set-DefaultAWSRegion -Region us-west-2
```
Use the following command to list all of the Systems Manager documents available for you. The list includes documents that you created and documents that were shared with you.
```
Get-SSMDocumentList -DocumentFilterList (@{"key"="Owner";"value"="All"})
```
Use the following command to get a specific document.
```
Get-SSMDocument –Name document name
```
Use the following command to get a description of the document.
```
Get-SSMDocumentDescription –Name document name
```

Use the following command to view the permissions of the document.


Get-SSMDocumentPermission –Name document name -PermissionType Share

Use the following command to modify the permissions for the document and share it. You must be the owner of the document to edit the permissions. This command privately shares the document with a specific individual, based on that person's AWS account ID.
```
Edit-SSMDocumentPermission –Name document name -PermissionType Share -AccountIdsToAdd AWS account ID
```
Use the following command to share a document publicly.
```
Edit-SSMDocumentPermission -Name document name -AccountIdsToAdd ('all') -PermissionType Share
```

Warning Javascript is disabled or is unavailable in your browser.

To use the AWS Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

« Previous Next »

Share a Document (Console)

Share a Document (AWS CLI)

Share a Document (AWS Tools for Windows PowerShell)