import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DescribeDocumentRequest, DescribeDocumentResult } from "../models/models_0"; import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeDocumentCommand}. */ export interface DescribeDocumentCommandInput extends DescribeDocumentRequest { } /** * @public * * The output of {@link DescribeDocumentCommand}. */ export interface DescribeDocumentCommandOutput extends DescribeDocumentResult, __MetadataBearer { } declare const DescribeDocumentCommand_base: { new (input: DescribeDocumentCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DescribeDocumentCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Describes the specified Amazon Web Services Systems Manager document (SSM document).

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, DescribeDocumentCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, DescribeDocumentCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * const client = new SSMClient(config); * const input = { // DescribeDocumentRequest * Name: "STRING_VALUE", // required * DocumentVersion: "STRING_VALUE", * VersionName: "STRING_VALUE", * }; * const command = new DescribeDocumentCommand(input); * const response = await client.send(command); * // { // DescribeDocumentResult * // Document: { // DocumentDescription * // Sha1: "STRING_VALUE", * // Hash: "STRING_VALUE", * // HashType: "Sha256" || "Sha1", * // Name: "STRING_VALUE", * // DisplayName: "STRING_VALUE", * // VersionName: "STRING_VALUE", * // Owner: "STRING_VALUE", * // CreatedDate: new Date("TIMESTAMP"), * // Status: "Creating" || "Active" || "Updating" || "Deleting" || "Failed", * // StatusInformation: "STRING_VALUE", * // DocumentVersion: "STRING_VALUE", * // Description: "STRING_VALUE", * // Parameters: [ // DocumentParameterList * // { // DocumentParameter * // Name: "STRING_VALUE", * // Type: "String" || "StringList", * // Description: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // }, * // ], * // PlatformTypes: [ // PlatformTypeList * // "Windows" || "Linux" || "MacOS", * // ], * // DocumentType: "Command" || "Policy" || "Automation" || "Session" || "Package" || "ApplicationConfiguration" || "ApplicationConfigurationSchema" || "DeploymentStrategy" || "ChangeCalendar" || "Automation.ChangeTemplate" || "ProblemAnalysis" || "ProblemAnalysisTemplate" || "CloudFormation" || "ConformancePackTemplate" || "QuickSetup" || "ManualApprovalPolicy" || "AutoApprovalPolicy", * // SchemaVersion: "STRING_VALUE", * // LatestVersion: "STRING_VALUE", * // DefaultVersion: "STRING_VALUE", * // DocumentFormat: "YAML" || "JSON" || "TEXT", * // TargetType: "STRING_VALUE", * // Tags: [ // TagList * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // AttachmentsInformation: [ // AttachmentInformationList * // { // AttachmentInformation * // Name: "STRING_VALUE", * // }, * // ], * // Requires: [ // DocumentRequiresList * // { // DocumentRequires * // Name: "STRING_VALUE", // required * // Version: "STRING_VALUE", * // RequireType: "STRING_VALUE", * // VersionName: "STRING_VALUE", * // }, * // ], * // Author: "STRING_VALUE", * // ReviewInformation: [ // ReviewInformationList * // { // ReviewInformation * // ReviewedTime: new Date("TIMESTAMP"), * // Status: "APPROVED" || "NOT_REVIEWED" || "PENDING" || "REJECTED", * // Reviewer: "STRING_VALUE", * // }, * // ], * // ApprovedVersion: "STRING_VALUE", * // PendingReviewVersion: "STRING_VALUE", * // ReviewStatus: "APPROVED" || "NOT_REVIEWED" || "PENDING" || "REJECTED", * // Category: [ // CategoryList * // "STRING_VALUE", * // ], * // CategoryEnum: [ // CategoryEnumList * // "STRING_VALUE", * // ], * // }, * // }; * * ``` * * @param DescribeDocumentCommandInput - {@link DescribeDocumentCommandInput} * @returns {@link DescribeDocumentCommandOutput} * @see {@link DescribeDocumentCommandInput} for command's `input` shape. * @see {@link DescribeDocumentCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidDocument} (client fault) *

The specified SSM document doesn't exist.

* * @throws {@link InvalidDocumentVersion} (client fault) *

The document version isn't valid or doesn't exist.

* * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* * * @public */ export declare class DescribeDocumentCommand extends DescribeDocumentCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDocumentRequest; output: DescribeDocumentResult; }; sdk: { input: DescribeDocumentCommandInput; output: DescribeDocumentCommandOutput; }; }; }