Get Document

ssm_get_document

R Documentation

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document)¶

Description¶

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

Usage¶

ssm_get_document(Name, VersionName, DocumentVersion, DocumentFormat)

Arguments¶

Name: [required] The name of the SSM document.
VersionName: An optional field specifying the version of the artifact associated with the document. For example, 12.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:

list(
  Name = "string",
  CreatedDate = as.POSIXct(
    "2015-01-01"
  ),
  DisplayName = "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"|"ProblemAnalysis"|"ProblemAnalysisTemplate"|"CloudFormation"|"ConformancePackTemplate"|"QuickSetup",
  DocumentFormat = "YAML"|"JSON"|"TEXT",
  Requires = list(
    list(
      Name = "string",
      Version = "string",
      RequireType = "string",
      VersionName = "string"
    )
  ),
  AttachmentsContent = list(
    list(
      Name = "string",
      Size = 123,
      Hash = "string",
      HashType = "Sha256",
      Url = "string"
    )
  ),
  ReviewStatus = "APPROVED"|"NOT_REVIEWED"|"PENDING"|"REJECTED"
)

Request syntax¶

svc$get_document(
  Name = "string",
  VersionName = "string",
  DocumentVersion = "string",
  DocumentFormat = "YAML"|"JSON"|"TEXT"
)