See: newGetDocument smart constructor.

Create a value of GetDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:versionName:GetDocument', getDocument_versionName - 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 can't be changed.

$sel:documentFormat:GetDocument', getDocument_documentFormat - Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

$sel:documentVersion:GetDocument', getDocument_documentVersion - The document version for which you want information.

$sel:name:GetDocument', getDocument_name - The name of the SSM document.

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 can't be changed.

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

The document version for which you want information.

The name of the SSM document.

See: newGetDocumentResponse smart constructor.

Create a value of GetDocumentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:GetDocumentResponse', getDocumentResponse_status - The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

$sel:documentType:GetDocumentResponse', getDocumentResponse_documentType - The document type.

$sel:versionName:GetDocument', getDocumentResponse_versionName - 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 can't be changed.

$sel:attachmentsContent:GetDocumentResponse', getDocumentResponse_attachmentsContent - A description of the document attachments, including names, locations, sizes, and so on.

$sel:reviewStatus:GetDocumentResponse', getDocumentResponse_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.

$sel:content:GetDocumentResponse', getDocumentResponse_content - The contents of the SSM document.

$sel:createdDate:GetDocumentResponse', getDocumentResponse_createdDate - The date the SSM document was created.

$sel:documentFormat:GetDocument', getDocumentResponse_documentFormat - The document format, either JSON or YAML.

$sel:name:GetDocument', getDocumentResponse_name - The name of the SSM document.

$sel:documentVersion:GetDocument', getDocumentResponse_documentVersion - The document version.

$sel:displayName:GetDocumentResponse', getDocumentResponse_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.

$sel:statusInformation:GetDocumentResponse', getDocumentResponse_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."

$sel:requires:GetDocumentResponse', getDocumentResponse_requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

$sel:httpStatus:GetDocumentResponse', getDocumentResponse_httpStatus - The response's http status code.

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

The document type.

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 can't be changed.

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

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.

The contents of the SSM document.

The date the SSM document was created.

The document format, either JSON or YAML.

The name of the SSM document.

The document version.

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.

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."

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

The response's http status code.