@aws-sdk/client-ssm
Version:
AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native
102 lines (101 loc) • 4.56 kB
TypeScript
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { UpdateDocumentMetadataRequest, UpdateDocumentMetadataResponse } from "../models/models_1";
/**
* @public
*/
export type { __MetadataBearer };
/**
* @public
*
* The input for {@link UpdateDocumentMetadataCommand}.
*/
export interface UpdateDocumentMetadataCommandInput extends UpdateDocumentMetadataRequest {
}
/**
* @public
*
* The output of {@link UpdateDocumentMetadataCommand}.
*/
export interface UpdateDocumentMetadataCommandOutput extends UpdateDocumentMetadataResponse, __MetadataBearer {
}
declare const UpdateDocumentMetadataCommand_base: {
new (input: UpdateDocumentMetadataCommandInput): import("@smithy/core/client").CommandImpl<UpdateDocumentMetadataCommandInput, UpdateDocumentMetadataCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
new (input: UpdateDocumentMetadataCommandInput): import("@smithy/core/client").CommandImpl<UpdateDocumentMetadataCommandInput, UpdateDocumentMetadataCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
* <important>
* <p>Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can
* continue to use the service as normal. For more information, see
* <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/change-manager-availability-change.html">Amazon Web Services Systems Manager Change Manager availability change</a>.</p>
* </important>
* <p>Updates information related to approval reviews for a specific version of a change template
* in Change Manager.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SSMClient, UpdateDocumentMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import
* // const { SSMClient, UpdateDocumentMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
* // import type { SSMClientConfig } from "@aws-sdk/client-ssm";
* const config = {}; // type is SSMClientConfig
* const client = new SSMClient(config);
* const input = { // UpdateDocumentMetadataRequest
* Name: "STRING_VALUE", // required
* DocumentVersion: "STRING_VALUE",
* DocumentReviews: { // DocumentReviews
* Action: "SendForReview" || "UpdateReview" || "Approve" || "Reject", // required
* Comment: [ // DocumentReviewCommentList
* { // DocumentReviewCommentSource
* Type: "Comment",
* Content: "STRING_VALUE",
* },
* ],
* },
* };
* const command = new UpdateDocumentMetadataCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param UpdateDocumentMetadataCommandInput - {@link UpdateDocumentMetadataCommandInput}
* @returns {@link UpdateDocumentMetadataCommandOutput}
* @see {@link UpdateDocumentMetadataCommandInput} for command's `input` shape.
* @see {@link UpdateDocumentMetadataCommandOutput} for command's `response` shape.
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
*
* @throws {@link InternalServerError} (server fault)
* <p>An error occurred on the server side.</p>
*
* @throws {@link InvalidDocument} (client fault)
* <p>The specified SSM document doesn't exist.</p>
*
* @throws {@link InvalidDocumentOperation} (client fault)
* <p>You attempted to delete a document while it is still shared. You must stop sharing the
* document before you can delete it.</p>
*
* @throws {@link InvalidDocumentVersion} (client fault)
* <p>The document version isn't valid or doesn't exist.</p>
*
* @throws {@link TooManyUpdates} (client fault)
* <p>There are concurrent updates for a resource that supports one update at a time.</p>
*
* @throws {@link SSMServiceException}
* <p>Base exception class for all service exceptions from SSM service.</p>
*
*
* @public
*/
export declare class UpdateDocumentMetadataCommand extends UpdateDocumentMetadataCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: UpdateDocumentMetadataRequest;
output: {};
};
sdk: {
input: UpdateDocumentMetadataCommandInput;
output: UpdateDocumentMetadataCommandOutput;
};
};
}