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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass GetDocumentRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_formatString

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

Returns:

  • (String)


7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7403

class GetDocumentRequest < Struct.new(
  :name,
  :version_name,
  :document_version,
  :document_format)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The document version for which you want information.

Returns:

  • (String)


7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7403

class GetDocumentRequest < Struct.new(
  :name,
  :version_name,
  :document_version,
  :document_format)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7403

class GetDocumentRequest < Struct.new(
  :name,
  :version_name,
  :document_version,
  :document_format)
  SENSITIVE = []
  include Aws::Structure
end

#version_nameString

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)


7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7403

class GetDocumentRequest < Struct.new(
  :name,
  :version_name,
  :document_version,
  :document_format)
  SENSITIVE = []
  include Aws::Structure
end