ssm_get_document: Gets the contents of the specified Systems Manager document

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Gets the contents of the specified Systems Manager document.

Usage

1
ssm_get_document(Name, VersionName, DocumentVersion, DocumentFormat)

Arguments

Name

[required] The name of the Systems Manager document.

VersionName

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.

DocumentVersion

The document version for which you want information.

DocumentFormat

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
list(
  Name = "string",
  VersionName = "string",
  DocumentVersion = "string",
  Status = "Creating"|"Active"|"Updating"|"Deleting"|"Failed",
  StatusInformation = "string",
  Content = "string",
  DocumentType = "Command"|"Policy"|"Automation"|"Session"|"Package"|"ApplicationConfiguration"|"ApplicationConfigurationSchema"|"DeploymentStrategy"|"ChangeCalendar"|"Automation.ChangeTemplate",
  DocumentFormat = "YAML"|"JSON"|"TEXT",
  Requires = list(
    list(
      Name = "string",
      Version = "string"
    )
  ),
  AttachmentsContent = list(
    list(
      Name = "string",
      Size = 123,
      Hash = "string",
      HashType = "Sha256",
      Url = "string"
    )
  ),
  ReviewStatus = "APPROVED"|"NOT_REVIEWED"|"PENDING"|"REJECTED"
)

Request syntax

1
2
3
4
5
6
svc$get_document(
  Name = "string",
  VersionName = "string",
  DocumentVersion = "string",
  DocumentFormat = "YAML"|"JSON"|"TEXT"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.