Class: Aws::SSM::Types::GetDocumentResult

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachments_contentArray<Types::AttachmentContent>

A description of the document attachments, including names, locations, sizes, and so on.

Returns:



7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#contentString

The contents of the Systems Manager document.

Returns:

  • (String)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#document_formatString

The document format, either JSON or YAML.

Returns:

  • (String)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#document_typeString

The document type.

Returns:

  • (String)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#requiresArray<Types::DocumentRequires>

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Returns:



7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

Returns:

  • (String)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#status_informationString

A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

Returns:

  • (String)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end

#version_nameString

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)


7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7411

class GetDocumentResult < Struct.new(
  :name,
  :version_name,
  :document_version,
  :status,
  :status_information,
  :content,
  :document_type,
  :document_format,
  :requires,
  :attachments_content)
  SENSITIVE = []
  include Aws::Structure
end