GetDocumentResult

import type { GetDocumentResult } from "https://aws-api.deno.dev/v0.3/services/ssm.ts?docs=full";

interface GetDocumentResult {

AttachmentsContent?: AttachmentContent[] | null;

Content?: string | null;

CreatedDate?: Date | number | null;

DisplayName?: string | null;

DocumentFormat?: DocumentFormat | null;

DocumentType?: DocumentType | null;

DocumentVersion?: string | null;

Name?: string | null;

Requires?: DocumentRequires[] | null;

ReviewStatus?: ReviewStatus | null;

Status?: DocumentStatus | null;

StatusInformation?: string | null;

VersionName?: string | null;

}

§Properties

AttachmentsContent?: AttachmentContent[] | null

[src]

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

Content?: string | null

[src]

The contents of the SSM document.

CreatedDate?: Date | number | null

[src]

The date the SSM document was created.

DisplayName?: string | null

[src]

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

DocumentFormat?: DocumentFormat | null

[src]

The document format, either JSON or YAML.

DocumentType?: DocumentType | null

[src]

The document type.

DocumentVersion?: string | null

[src]

The document version.

Name?: string | null

[src]

The name of the SSM document.

Requires?: DocumentRequires[] | null

[src]

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

ReviewStatus?: ReviewStatus | null

[src]

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.

Status?: DocumentStatus | null

[src]

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

StatusInformation?: string | null

[src]

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

VersionName?: string | null

[src]

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.