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

Class: Aws::SSM::Types::DescribeDocumentRequest

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 DescribeDocumentRequest data as a hash:

{
  name: "DocumentARN", # required
  document_version: "DocumentVersion",
  version_name: "DocumentVersionName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#document_versionString

The document version for which you want information. Can be a specific version or the default version.

Returns:

  • (String)


3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3903

class DescribeDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name)
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3903

class DescribeDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name)
  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 cannot be changed.

Returns:

  • (String)


3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3903

class DescribeDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name)
  include Aws::Structure
end