Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

ListDocuments

Describes one or more of your Systems Manager documents.

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

One or more filters. Use a filter to return a more specific list of results.

Type: Array of DocumentFilter objects

Array Members: Minimum number of 1 item.

Required: No

Filters

One or more filters. Use a filter to return a more specific list of results.

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" ], "SchemaVersion": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "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: 400

InvalidFilterKey

The specified key is not valid.

HTTP Status Code: 400

InvalidNextToken

The specified token is not valid.

HTTP Status Code: 400

See Also

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