CmdID / aws / aws ssm

aws ssm list-documents

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. AWS CLI reference

2 examples 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To list documents

The following list-documents example lists documents owned by the requesting account tagged with the custom tag.

aws ssm list-documents --filters Key=Owner,Values=Self Key=tag:DocUse,Values=TestingIdentify

--filtersOne or more DocumentKeyValuesFilter objects.

Its output

{
    "DocumentIdentifiers": [
        {
            "Name": "Example",
            "Owner": "29884EXAMPLE",
            "PlatformTypes": [
                "Windows",
                "Linux"
            ],
            "DocumentVersion": "1",
            "DocumentType": "Automation",
            "SchemaVersion": "0.3",
            "DocumentFormat": "YAML",
            "Tags": [
                {
                    "Key": "DocUse",
                    "Value": "Testing"
                }
            ]
        }
    ]
}

For more information, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.

Example 2: To list shared documents

The following list-documents example lists shared documents, including private shared documents not owned by AWS.

aws ssm list-documents --filters Key=Name,Values=sharedDocNamePrefix Key=Owner,Values=PrivateIdentify

--filtersOne or more DocumentKeyValuesFilter objects.

Its output

{
    "DocumentIdentifiers": [
        {
            "Name": "Example",
            "Owner": "12345EXAMPLE",
            "PlatformTypes": [
                "Windows",
                "Linux"
            ],
            "DocumentVersion": "1",
            "DocumentType": "Command",
            "SchemaVersion": "0.3",
            "DocumentFormat": "YAML",
            "Tags": []
        }
    ]
}

For more information, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.

Options

4 in the AWS CLI reference

--document-filter-listThis data type is deprecated.

--filtersOne or more DocumentKeyValuesFilter objects.

--max-resultsThe maximum number of items to return for this call.

--next-tokenThe token for the next set of items to return.