You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::GetDocumentRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetDocumentRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "DocumentARN", # required
  version_name: "DocumentVersionName",
  document_version: "DocumentVersion",
  document_format: "YAML", # accepts YAML, JSON, TEXT
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#document_format ⇒ String

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

Possible values:

  • YAML
  • JSON
  • TEXT

Returns:

  • (String) —

    Returns the document in the specified format.

#document_version ⇒ String

The document version for which you want information.

Returns:

  • (String) —

    The document version for which you want information.

#name ⇒ String

The name of the Systems Manager document.

Returns:

  • (String) —

    The name of the Systems Manager document.

#version_name ⇒ String

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.

Returns:

  • (String) —

    An optional field specifying the version of the artifact associated with the document.