@aws-sdk/client-proton 3.369.0 → 3.370.0

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

@@ -0,0 +1,112 @@
+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 { ListDeploymentsInput, ListDeploymentsOutput } from "../models/models_0";
+import { ProtonClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ProtonClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListDeploymentsCommand}.
+ */
+export interface ListDeploymentsCommandInput extends ListDeploymentsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDeploymentsCommand}.
+ */
+export interface ListDeploymentsCommandOutput extends ListDeploymentsOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>List deployments. You can filter the result list by environment, service, or a single service instance.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ProtonClient, ListDeploymentsCommand } from "@aws-sdk/client-proton"; // ES Modules import
+ * // const { ProtonClient, ListDeploymentsCommand } = require("@aws-sdk/client-proton"); // CommonJS import
+ * const client = new ProtonClient(config);
+ * const input = { // ListDeploymentsInput
+ *   nextToken: "STRING_VALUE",
+ *   environmentName: "STRING_VALUE",
+ *   serviceName: "STRING_VALUE",
+ *   serviceInstanceName: "STRING_VALUE",
+ *   componentName: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListDeploymentsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDeploymentsOutput
+ * //   nextToken: "STRING_VALUE",
+ * //   deployments: [ // DeploymentSummaryList // required
+ * //     { // DeploymentSummary
+ * //       id: "STRING_VALUE", // required
+ * //       arn: "STRING_VALUE", // required
+ * //       targetArn: "STRING_VALUE", // required
+ * //       targetResourceCreatedAt: new Date("TIMESTAMP"), // required
+ * //       targetResourceType: "STRING_VALUE", // required
+ * //       createdAt: new Date("TIMESTAMP"), // required
+ * //       lastModifiedAt: new Date("TIMESTAMP"), // required
+ * //       completedAt: new Date("TIMESTAMP"),
+ * //       environmentName: "STRING_VALUE", // required
+ * //       serviceName: "STRING_VALUE",
+ * //       serviceInstanceName: "STRING_VALUE",
+ * //       componentName: "STRING_VALUE",
+ * //       lastAttemptedDeploymentId: "STRING_VALUE",
+ * //       lastSucceededDeploymentId: "STRING_VALUE",
+ * //       deploymentStatus: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListDeploymentsCommandInput - {@link ListDeploymentsCommandInput}
+ * @returns {@link ListDeploymentsCommandOutput}
+ * @see {@link ListDeploymentsCommandInput} for command's `input` shape.
+ * @see {@link ListDeploymentsCommandOutput} for command's `response` shape.
+ * @see {@link ProtonClientResolvedConfig | config} for ProtonClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>There <i>isn't</i> sufficient access for performing this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request failed to register with the service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource <i>wasn't</i> found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
+ *
+ * @throws {@link ProtonServiceException}
+ * <p>Base exception class for all service exceptions from Proton service.</p>
+ *
+ */
+export declare class ListDeploymentsCommand extends $Command<ListDeploymentsCommandInput, ListDeploymentsCommandOutput, ProtonClientResolvedConfig> {
+    readonly input: ListDeploymentsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListDeploymentsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ProtonClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDeploymentsCommandInput, ListDeploymentsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -33,6 +33,7 @@ export interface ListEnvironmentOutputsCommandOutput extends ListEnvironmentOutp
  * const input = { // ListEnvironmentOutputsInput
  *   environmentName: "STRING_VALUE", // required
  *   nextToken: "STRING_VALUE",
+ *   deploymentId: "STRING_VALUE",
  * };
  * const command = new ListEnvironmentOutputsCommand(input);
  * const response = await client.send(command);

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

@@ -62,6 +62,8 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsOutput, _
  * //       environmentAccountId: "STRING_VALUE",
  * //       provisioning: "STRING_VALUE",
  * //       componentRoleArn: "STRING_VALUE",
+ * //       lastAttemptedDeploymentId: "STRING_VALUE",
+ * //       lastSucceededDeploymentId: "STRING_VALUE",
  * //     },
  * //   ],
  * // };

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

@@ -34,6 +34,7 @@ export interface ListServiceInstanceOutputsCommandOutput extends ListServiceInst
  *   serviceInstanceName: "STRING_VALUE", // required
  *   serviceName: "STRING_VALUE", // required
  *   nextToken: "STRING_VALUE",
+ *   deploymentId: "STRING_VALUE",
  * };
  * const command = new ListServiceInstanceOutputsCommand(input);
  * const response = await client.send(command);

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

@@ -62,6 +62,8 @@ export interface ListServiceInstancesCommandOutput extends ListServiceInstancesO
  * //       templateMinorVersion: "STRING_VALUE", // required
  * //       deploymentStatus: "STRING_VALUE", // required
  * //       deploymentStatusMessage: "STRING_VALUE",
+ * //       lastAttemptedDeploymentId: "STRING_VALUE",
+ * //       lastSucceededDeploymentId: "STRING_VALUE",
  * //     },
  * //   ],
  * // };

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

@@ -33,6 +33,7 @@ export interface ListServicePipelineOutputsCommandOutput extends ListServicePipe
  * const input = { // ListServicePipelineOutputsInput
  *   serviceName: "STRING_VALUE", // required
  *   nextToken: "STRING_VALUE",
+ *   deploymentId: "STRING_VALUE",
  * };
  * const command = new ListServicePipelineOutputsCommand(input);
  * const response = await client.send(command);

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

@@ -23,8 +23,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
 }
 /**
  * @public
- * <p>List tags for a resource. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
- *     <i>Proton User Guide</i>.</p>
+ * <p>List tags for a resource. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton
+ *     resources and tagging</a> in the <i>Proton User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -23,10 +23,8 @@ export interface NotifyResourceDeploymentStatusChangeCommandOutput extends Notif
 }
 /**
  * @public
- * <p>Notify Proton of status changes to a provisioned resource when you use self-managed
- *    provisioning.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed
- *     provisioning</a> in the <i>Proton User Guide</i>.</p>
+ * <p>Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a> in the <i>Proton User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -23,10 +23,9 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
 }
 /**
  * @public
- * <p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton
- *    resource.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
- *     <i>Proton User Guide</i>.</p>
+ * <p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in
+ *    the <i>Proton User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -23,10 +23,9 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
 }
 /**
  * @public
- * <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with
- *    an Proton resource.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
- *     <i>Proton User Guide</i>.</p>
+ * <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in
+ *    the <i>Proton User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -66,6 +66,8 @@ export interface UpdateComponentCommandOutput extends UpdateComponentOutput, __M
  * //     deploymentStatusMessage: "STRING_VALUE",
  * //     serviceSpec: "STRING_VALUE",
  * //     lastClientRequestToken: "STRING_VALUE",
+ * //     lastAttemptedDeploymentId: "STRING_VALUE",
+ * //     lastSucceededDeploymentId: "STRING_VALUE",
  * //   },
  * // };
  *

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

@@ -123,6 +123,8 @@ export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentOutput,
  * //     },
  * //     componentRoleArn: "STRING_VALUE",
  * //     codebuildRoleArn: "STRING_VALUE",
+ * //     lastAttemptedDeploymentId: "STRING_VALUE",
+ * //     lastSucceededDeploymentId: "STRING_VALUE",
  * //   },
  * // };
  *

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

@@ -72,6 +72,8 @@ export interface UpdateServiceCommandOutput extends UpdateServiceOutput, __Metad
  * //       deploymentStatus: "STRING_VALUE", // required
  * //       deploymentStatusMessage: "STRING_VALUE",
  * //       spec: "STRING_VALUE",
+ * //       lastAttemptedDeploymentId: "STRING_VALUE",
+ * //       lastSucceededDeploymentId: "STRING_VALUE",
  * //     },
  * //     repositoryConnectionArn: "STRING_VALUE",
  * //     repositoryId: "STRING_VALUE",

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

@@ -66,6 +66,8 @@ export interface UpdateServiceInstanceCommandOutput extends UpdateServiceInstanc
  * //     deploymentStatusMessage: "STRING_VALUE",
  * //     spec: "STRING_VALUE",
  * //     lastClientRequestToken: "STRING_VALUE",
+ * //     lastAttemptedDeploymentId: "STRING_VALUE",
+ * //     lastSucceededDeploymentId: "STRING_VALUE",
  * //   },
  * // };
  *

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

@@ -91,6 +91,8 @@ export interface UpdateServicePipelineCommandOutput extends UpdateServicePipelin
  * //     deploymentStatus: "STRING_VALUE", // required
  * //     deploymentStatusMessage: "STRING_VALUE",
  * //     spec: "STRING_VALUE",
+ * //     lastAttemptedDeploymentId: "STRING_VALUE",
+ * //     lastSucceededDeploymentId: "STRING_VALUE",
  * //   },
  * // };
  *

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

@@ -23,10 +23,9 @@ export interface UpdateTemplateSyncConfigCommandOutput extends UpdateTemplateSyn
 }
 /**
  * @public
- * <p>Update template sync configuration parameters, except for the <code>templateName</code> and
- *     <code>templateType</code>. Repository details (branch, name, and provider) should be of a linked
- *    repository. A linked repository is a repository that has been registered with Proton. For more
- *    information, see <a>CreateRepository</a>.</p>
+ * <p>Update template sync configuration parameters, except for the <code>templateName</code> and <code>templateType</code>. Repository details
+ *    (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For
+ *    more information, see <a>CreateRepository</a>.</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

@@ -16,6 +16,7 @@ export * from "./CreateServiceTemplateCommand";
 export * from "./CreateServiceTemplateVersionCommand";
 export * from "./CreateTemplateSyncConfigCommand";
 export * from "./DeleteComponentCommand";
+export * from "./DeleteDeploymentCommand";
 export * from "./DeleteEnvironmentAccountConnectionCommand";
 export * from "./DeleteEnvironmentCommand";
 export * from "./DeleteEnvironmentTemplateCommand";
@@ -28,6 +29,7 @@ export * from "./DeleteServiceTemplateVersionCommand";
 export * from "./DeleteTemplateSyncConfigCommand";
 export * from "./GetAccountSettingsCommand";
 export * from "./GetComponentCommand";
+export * from "./GetDeploymentCommand";
 export * from "./GetEnvironmentAccountConnectionCommand";
 export * from "./GetEnvironmentCommand";
 export * from "./GetEnvironmentTemplateCommand";
@@ -47,6 +49,7 @@ export * from "./GetTemplateSyncStatusCommand";
 export * from "./ListComponentOutputsCommand";
 export * from "./ListComponentProvisionedResourcesCommand";
 export * from "./ListComponentsCommand";
+export * from "./ListDeploymentsCommand";
 export * from "./ListEnvironmentAccountConnectionsCommand";
 export * from "./ListEnvironmentOutputsCommand";
 export * from "./ListEnvironmentProvisionedResourcesCommand";