paws.management (version 0.1.12)

ssm_list_documents: Returns all Systems Manager (SSM) documents in the current AWS account and Region

Description

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.

Usage

ssm_list_documents(DocumentFilterList, Filters, MaxResults, NextToken)

Value

A list with the following syntax:

list(
  DocumentIdentifiers = list(
    list(
      Name = "string",
      Owner = "string",
      VersionName = "string",
      PlatformTypes = list(
        "Windows"|"Linux"
      ),
      DocumentVersion = "string",
      DocumentType = "Command"|"Policy"|"Automation"|"Session"|"Package"|"ApplicationConfiguration"|"ApplicationConfigurationSchema"|"DeploymentStrategy"|"ChangeCalendar"|"Automation.ChangeTemplate",
      SchemaVersion = "string",
      DocumentFormat = "YAML"|"JSON"|"TEXT",
      TargetType = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Requires = list(
        list(
          Name = "string",
          Version = "string"
        )
      ),
      ReviewStatus = "APPROVED"|"NOT_REVIEWED"|"PENDING"|"REJECTED",
      Author = "string"
    )
  ),
  NextToken = "string"
)

Arguments

DocumentFilterList

This data type is deprecated. Instead, use Filters.

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.

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.

NextToken

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

Request syntax

svc$list_documents(
  DocumentFilterList = list(
    list(
      key = "Name"|"Owner"|"PlatformTypes"|"DocumentType",
      value = "string"
    )
  ),
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)