/AWS1/CL_SSMGETDOCUMENTRESULT

GetDocumentResult

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/SSMDOCUMENTARN /AWS1/SSMDOCUMENTARN

The name of the SSM document.

iv_createddate TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME

The date the SSM document was created.

iv_displayname TYPE /AWS1/SSMDOCUMENTDISPLAYNAME /AWS1/SSMDOCUMENTDISPLAYNAME

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

iv_versionname TYPE /AWS1/SSMDOCUMENTVERSIONNAME /AWS1/SSMDOCUMENTVERSIONNAME

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

iv_documentversion TYPE /AWS1/SSMDOCUMENTVERSION /AWS1/SSMDOCUMENTVERSION

The document version.

iv_status TYPE /AWS1/SSMDOCUMENTSTATUS /AWS1/SSMDOCUMENTSTATUS

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

iv_statusinformation TYPE /AWS1/SSMDOCSTATUSINFORMATION /AWS1/SSMDOCSTATUSINFORMATION

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

iv_content TYPE /AWS1/SSMDOCUMENTCONTENT /AWS1/SSMDOCUMENTCONTENT

The contents of the SSM document.

iv_documenttype TYPE /AWS1/SSMDOCUMENTTYPE /AWS1/SSMDOCUMENTTYPE

The document type.

iv_documentformat TYPE /AWS1/SSMDOCUMENTFORMAT /AWS1/SSMDOCUMENTFORMAT

The document format, either JSON or YAML.

it_requires TYPE /AWS1/CL_SSMDOCUMENTREQUIRES=>TT_DOCUMENTREQUIRESLIST TT_DOCUMENTREQUIRESLIST

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

it_attachmentscontent TYPE /AWS1/CL_SSMATTACHMENTCONTENT=>TT_ATTACHMENTCONTENTLIST TT_ATTACHMENTCONTENTLIST

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

iv_reviewstatus TYPE /AWS1/SSMREVIEWSTATUS /AWS1/SSMREVIEWSTATUS

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

---

Queryable Attributes

Name

The name of the SSM document.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

CreatedDate

The date the SSM document was created.

Accessible with the following methods

Method	Description
GET_CREATEDDATE()	Getter for CREATEDDATE, with configurable default
ASK_CREATEDDATE()	Getter for CREATEDDATE w/ exceptions if field has no value
HAS_CREATEDDATE()	Determine if CREATEDDATE has a value

DisplayName

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Accessible with the following methods

Method	Description
GET_DISPLAYNAME()	Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME()	Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME()	Determine if DISPLAYNAME has a value

VersionName

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

Accessible with the following methods

Method	Description
GET_VERSIONNAME()	Getter for VERSIONNAME, with configurable default
ASK_VERSIONNAME()	Getter for VERSIONNAME w/ exceptions if field has no value
HAS_VERSIONNAME()	Determine if VERSIONNAME has a value

DocumentVersion

The document version.

Accessible with the following methods

Method	Description
GET_DOCUMENTVERSION()	Getter for DOCUMENTVERSION, with configurable default
ASK_DOCUMENTVERSION()	Getter for DOCUMENTVERSION w/ exceptions if field has no val
HAS_DOCUMENTVERSION()	Determine if DOCUMENTVERSION has a value

Status

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

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

StatusInformation

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

Accessible with the following methods

Method	Description
GET_STATUSINFORMATION()	Getter for STATUSINFORMATION, with configurable default
ASK_STATUSINFORMATION()	Getter for STATUSINFORMATION w/ exceptions if field has no v
HAS_STATUSINFORMATION()	Determine if STATUSINFORMATION has a value

Content

The contents of the SSM document.

Accessible with the following methods

Method	Description
GET_CONTENT()	Getter for CONTENT, with configurable default
ASK_CONTENT()	Getter for CONTENT w/ exceptions if field has no value
HAS_CONTENT()	Determine if CONTENT has a value

DocumentType

The document type.

Accessible with the following methods

Method	Description
GET_DOCUMENTTYPE()	Getter for DOCUMENTTYPE, with configurable default
ASK_DOCUMENTTYPE()	Getter for DOCUMENTTYPE w/ exceptions if field has no value
HAS_DOCUMENTTYPE()	Determine if DOCUMENTTYPE has a value

DocumentFormat

The document format, either JSON or YAML.

Accessible with the following methods

Method	Description
GET_DOCUMENTFORMAT()	Getter for DOCUMENTFORMAT, with configurable default
ASK_DOCUMENTFORMAT()	Getter for DOCUMENTFORMAT w/ exceptions if field has no valu
HAS_DOCUMENTFORMAT()	Determine if DOCUMENTFORMAT has a value

Requires

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

Accessible with the following methods

Method	Description
GET_REQUIRES()	Getter for REQUIRES, with configurable default
ASK_REQUIRES()	Getter for REQUIRES w/ exceptions if field has no value
HAS_REQUIRES()	Determine if REQUIRES has a value

AttachmentsContent

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

Accessible with the following methods

Method	Description
GET_ATTACHMENTSCONTENT()	Getter for ATTACHMENTSCONTENT, with configurable default
ASK_ATTACHMENTSCONTENT()	Getter for ATTACHMENTSCONTENT w/ exceptions if field has no
HAS_ATTACHMENTSCONTENT()	Determine if ATTACHMENTSCONTENT has a value

ReviewStatus

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

Accessible with the following methods

Method	Description
GET_REVIEWSTATUS()	Getter for REVIEWSTATUS, with configurable default
ASK_REVIEWSTATUS()	Getter for REVIEWSTATUS w/ exceptions if field has no value
HAS_REVIEWSTATUS()	Determine if REVIEWSTATUS has a value