Class: Aws::SSM::Types::GetDocumentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::GetDocumentRequest
- Includes:
- Aws::Structure
- Defined in:
- 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
}
Instance Attribute Summary collapse
-
#document_format ⇒ String
Returns the document in the specified format.
-
#document_version ⇒ String
The document version for which you want information.
-
#name ⇒ String
The name of the Systems Manager document.
-
#version_name ⇒ String
An optional field specifying the version of the artifact associated with the document.
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.
6851 6852 6853 6854 6855 6856 6857 |
# File 'lib/aws-sdk-ssm/types.rb', line 6851 class GetDocumentRequest < Struct.new( :name, :version_name, :document_version, :document_format) include Aws::Structure end |
#document_version ⇒ String
The document version for which you want information.
6851 6852 6853 6854 6855 6856 6857 |
# File 'lib/aws-sdk-ssm/types.rb', line 6851 class GetDocumentRequest < Struct.new( :name, :version_name, :document_version, :document_format) include Aws::Structure end |
#name ⇒ String
The name of the Systems Manager document.
6851 6852 6853 6854 6855 6856 6857 |
# File 'lib/aws-sdk-ssm/types.rb', line 6851 class GetDocumentRequest < Struct.new( :name, :version_name, :document_version, :document_format) include Aws::Structure end |
#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 cannot be changed.
6851 6852 6853 6854 6855 6856 6857 |
# File 'lib/aws-sdk-ssm/types.rb', line 6851 class GetDocumentRequest < Struct.new( :name, :version_name, :document_version, :document_format) include Aws::Structure end |