@aws-sdk/client-ssm-incidents 3.451.0 → 3.454.0

package/dist-types/commands/BatchGetIncidentFindingsCommand.d.ts

@@ -0,0 +1,122 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { BatchGetIncidentFindingsInput, BatchGetIncidentFindingsOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link BatchGetIncidentFindingsCommand}.
+ */
+export interface BatchGetIncidentFindingsCommandInput extends BatchGetIncidentFindingsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link BatchGetIncidentFindingsCommand}.
+ */
+export interface BatchGetIncidentFindingsCommandOutput extends BatchGetIncidentFindingsOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding
+ *       represents a recent application environment change made by an CodeDeploy
+ *       deployment or an CloudFormation stack creation or update that can be investigated as a
+ *       potential cause of the incident.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SSMIncidentsClient, BatchGetIncidentFindingsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
+ * // const { SSMIncidentsClient, BatchGetIncidentFindingsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
+ * const client = new SSMIncidentsClient(config);
+ * const input = { // BatchGetIncidentFindingsInput
+ *   incidentRecordArn: "STRING_VALUE", // required
+ *   findingIds: [ // FindingIdList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new BatchGetIncidentFindingsCommand(input);
+ * const response = await client.send(command);
+ * // { // BatchGetIncidentFindingsOutput
+ * //   findings: [ // FindingList // required
+ * //     { // Finding
+ * //       id: "STRING_VALUE", // required
+ * //       creationTime: new Date("TIMESTAMP"), // required
+ * //       lastModifiedTime: new Date("TIMESTAMP"), // required
+ * //       details: { // FindingDetails Union: only one key present
+ * //         codeDeployDeployment: { // CodeDeployDeployment
+ * //           startTime: new Date("TIMESTAMP"), // required
+ * //           endTime: new Date("TIMESTAMP"),
+ * //           deploymentGroupArn: "STRING_VALUE", // required
+ * //           deploymentId: "STRING_VALUE", // required
+ * //         },
+ * //         cloudFormationStackUpdate: { // CloudFormationStackUpdate
+ * //           startTime: new Date("TIMESTAMP"), // required
+ * //           endTime: new Date("TIMESTAMP"),
+ * //           stackArn: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   errors: [ // BatchGetIncidentFindingsErrorList // required
+ * //     { // BatchGetIncidentFindingsError
+ * //       findingId: "STRING_VALUE", // required
+ * //       code: "STRING_VALUE", // required
+ * //       message: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param BatchGetIncidentFindingsCommandInput - {@link BatchGetIncidentFindingsCommandInput}
+ * @returns {@link BatchGetIncidentFindingsCommandOutput}
+ * @see {@link BatchGetIncidentFindingsCommandInput} for command's `input` shape.
+ * @see {@link BatchGetIncidentFindingsCommandOutput} for command's `response` shape.
+ * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *       failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which doesn't exist. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *       service.</p>
+ *
+ * @throws {@link SSMIncidentsServiceException}
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
+ *
+ */
+export declare class BatchGetIncidentFindingsCommand extends $Command<BatchGetIncidentFindingsCommandInput, BatchGetIncidentFindingsCommandOutput, SSMIncidentsClientResolvedConfig> {
+    readonly input: BatchGetIncidentFindingsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: BatchGetIncidentFindingsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetIncidentFindingsCommandInput, BatchGetIncidentFindingsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/ListIncidentFindingsCommand.d.ts

@@ -0,0 +1,101 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ListIncidentFindingsInput, ListIncidentFindingsOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListIncidentFindingsCommand}.
+ */
+export interface ListIncidentFindingsCommandInput extends ListIncidentFindingsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListIncidentFindingsCommand}.
+ */
+export interface ListIncidentFindingsCommandOutput extends ListIncidentFindingsOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves a list of the IDs of findings, plus their last modified times, that have been
+ *       identified for a specified incident. A finding represents a recent application environment
+ *       change made by an CloudFormation stack creation or update or an CodeDeploy
+ *       deployment that can be investigated as a potential cause of the incident.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SSMIncidentsClient, ListIncidentFindingsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
+ * // const { SSMIncidentsClient, ListIncidentFindingsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
+ * const client = new SSMIncidentsClient(config);
+ * const input = { // ListIncidentFindingsInput
+ *   incidentRecordArn: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListIncidentFindingsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListIncidentFindingsOutput
+ * //   findings: [ // FindingSummaryList // required
+ * //     { // FindingSummary
+ * //       id: "STRING_VALUE", // required
+ * //       lastModifiedTime: new Date("TIMESTAMP"), // required
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListIncidentFindingsCommandInput - {@link ListIncidentFindingsCommandInput}
+ * @returns {@link ListIncidentFindingsCommandOutput}
+ * @see {@link ListIncidentFindingsCommandInput} for command's `input` shape.
+ * @see {@link ListIncidentFindingsCommandOutput} for command's `response` shape.
+ * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *       failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which doesn't exist. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *       service.</p>
+ *
+ * @throws {@link SSMIncidentsServiceException}
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
+ *
+ */
+export declare class ListIncidentFindingsCommand extends $Command<ListIncidentFindingsCommandInput, ListIncidentFindingsCommandOutput, SSMIncidentsClientResolvedConfig> {
+    readonly input: ListIncidentFindingsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListIncidentFindingsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListIncidentFindingsCommandInput, ListIncidentFindingsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -23,7 +23,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 }
 /**
  * @public
- * <p>Lists the tags that are attached to the specified response plan.</p>
+ * <p>Lists the tags that are attached to the specified response plan or incident.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./BatchGetIncidentFindingsCommand";
 export * from "./CreateReplicationSetCommand";
 export * from "./CreateResponsePlanCommand";
 export * from "./CreateTimelineEventCommand";
@@ -11,6 +12,7 @@ export * from "./GetReplicationSetCommand";
 export * from "./GetResourcePoliciesCommand";
 export * from "./GetResponsePlanCommand";
 export * from "./GetTimelineEventCommand";
+export * from "./ListIncidentFindingsCommand";
 export * from "./ListIncidentRecordsCommand";
 export * from "./ListRelatedItemsCommand";
 export * from "./ListReplicationSetsCommand";