ListDocuments - AWS Systems Manager

ListDocuments

Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.

Request Syntax

{ "DocumentFilterList": [ { "key": "string", "value": "string" } ], "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DocumentFilterList

This data type is deprecated. Instead, use Filters.

Type: Array of DocumentFilter objects

Array Members: Minimum number of 1 item.

Required: No

Filters

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Type: Array of DocumentKeyValuesFilter objects

Array Members: Minimum number of 0 items. Maximum number of 6 items.

Required: No

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Required: No

Response Syntax

{ "DocumentIdentifiers": [ { "DocumentFormat": "string", "DocumentType": "string", "DocumentVersion": "string", "Name": "string", "Owner": "string", "PlatformTypes": [ "string" ], "Requires": [ { "Name": "string", "Version": "string" } ], "SchemaVersion": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DocumentIdentifiers

The names of the Systems Manager documents.

Type: Array of DocumentIdentifier objects

NextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidFilterKey

The specified key is not valid.

HTTP Status Code: 400

InvalidNextToken

The specified token is not valid.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListDocuments Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20200325T150301Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200325/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 97 { "Filters":[ { "Key":"Owner", "Values":[ "Self" ] }, { "Key":"tag:DocUse", "Values":[ "Testing" ] } ] }

Sample Response

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: