/ - Amazon Simple Systems Manager (SSM)

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "DocumentFilterList": [], "Filters": [], "MaxResults": 0, "NextToken": "string" }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

DocumentFilterList

array[object (DocumentFilter) {2}]

optional

This data type is deprecated. Instead, use Filters.

>= 1 items

key

enum<string>

required

The name of the filter.

Allowed values:

NameOwnerPlatformTypesDocumentType

value

string

required

The value of the filter.

>= 1 characters

Filters

array [object]

optional

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.

>= 0 items<= 6 items

MaxResults

integer

optional

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.

>= 1<= 50

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

DocumentIdentifiers

array[object (DocumentIdentifier) {15}]

optional

The names of the SSM documents.

Name

string

optional

The name of the SSM document.

Match pattern:

^[a-zA-Z0-9_\-.:/]{3,128}$

CreatedDate

string <date-time>

optional

The date the SSM document was created.

DisplayName

string

optional

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

<= 1024 characters

Match pattern:

^[\w\.\-\:\/ ]*$

Owner

string

optional

The Amazon Web Services user that created the document.

VersionName

string

optional

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

Match pattern:

^[a-zA-Z0-9_\-.]{1,128}$

PlatformTypes

array[string]

optional

The operating system platform.

Allowed values:

WindowsLinuxMacOS

DocumentVersion

string

optional

The document version.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

DocumentType

enum<string>

optional

The document type.

Allowed values:

CommandPolicyAutomationSessionPackageApplicationConfigurationApplicationConfigurationSchemaDeploymentStrategyChangeCalendarAutomation.ChangeTemplateProblemAnalysisProblemAnalysisTemplateCloudFormationConformancePackTemplateQuickSetup

SchemaVersion

string

optional

The schema version.

Match pattern:

([0-9]+)\.([0-9]+)

DocumentFormat

enum<string>

optional

The document format, either JSON or YAML.

Allowed values:

YAMLJSONTEXT

TargetType

string

optional

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

<= 200 characters

Match pattern:

^\/[\w\.\-\:\/]*$