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

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
  document_version: "DocumentVersion",
  document_format: "YAML", # accepts YAML, JSON
}

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)


4598
4599
4600
4601
4602
4603
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4598

class GetDocumentRequest < Struct.new(
  :name,
  :document_version,
  :document_format)
  include Aws::Structure
end

#document_versionString

The document version for which you want information.

Returns:

  • (String)


4598
4599
4600
4601
4602
4603
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4598

class GetDocumentRequest < Struct.new(
  :name,
  :document_version,
  :document_format)
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


4598
4599
4600
4601
4602
4603
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4598

class GetDocumentRequest < Struct.new(
  :name,
  :document_version,
  :document_format)
  include Aws::Structure
end