docs(client-robomaker): Documentation update: added support notices t…

…o each API action.
aws · Oct 11, 2024 · bc47ba4 · bc47ba4
1 parent 9d746f6
commit bc47ba4
Show file tree

Hide file tree

Showing 59 changed files with 639 additions and 179 deletions.
diff --git a/clients/client-robomaker/src/commands/BatchDeleteWorldsCommand.ts b/clients/client-robomaker/src/commands/BatchDeleteWorldsCommand.ts
@@ -28,7 +28,15 @@ export interface BatchDeleteWorldsCommandInput extends BatchDeleteWorldsRequest
 export interface BatchDeleteWorldsCommandOutput extends BatchDeleteWorldsResponse, __MetadataBearer {}
 
 /**
- * <p>Deletes one or more worlds in a batch operation.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Deletes one or more worlds in a batch operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/BatchDescribeSimulationJobCommand.ts b/clients/client-robomaker/src/commands/BatchDescribeSimulationJobCommand.ts
@@ -28,7 +28,15 @@ export interface BatchDescribeSimulationJobCommandInput extends BatchDescribeSim
 export interface BatchDescribeSimulationJobCommandOutput extends BatchDescribeSimulationJobResponse, __MetadataBearer {}
 
 /**
- * <p>Describes one or more simulation jobs.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Describes one or more simulation jobs.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CancelDeploymentJobCommand.ts b/clients/client-robomaker/src/commands/CancelDeploymentJobCommand.ts
@@ -28,10 +28,10 @@ export interface CancelDeploymentJobCommandInput extends CancelDeploymentJobRequ
 export interface CancelDeploymentJobCommandOutput extends CancelDeploymentJobResponse, __MetadataBearer {}
 
 /**
- * <p>Cancels the specified deployment job.</p>
- *          <important>
- *             <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.</p>
+ * <important>
+ *             <p>This API is no longer supported. For more information, see the May 2, 2022 update in the <a href="https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-may2022">Support policy</a> page.</p>
  *          </important>
+ *          <p>Cancels the specified deployment job.</p>
  *
  * @deprecated Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
  * @example

diff --git a/clients/client-robomaker/src/commands/CancelSimulationJobBatchCommand.ts b/clients/client-robomaker/src/commands/CancelSimulationJobBatchCommand.ts
@@ -28,7 +28,15 @@ export interface CancelSimulationJobBatchCommandInput extends CancelSimulationJo
 export interface CancelSimulationJobBatchCommandOutput extends CancelSimulationJobBatchResponse, __MetadataBearer {}
 
 /**
- * <p>Cancels a simulation job batch. When you cancel a simulation job batch, you are also
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Cancels a simulation job batch. When you cancel a simulation job batch, you are also
  *          cancelling all of the active simulation jobs created as part of the batch. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-robomaker/src/commands/CancelSimulationJobCommand.ts b/clients/client-robomaker/src/commands/CancelSimulationJobCommand.ts
@@ -28,7 +28,15 @@ export interface CancelSimulationJobCommandInput extends CancelSimulationJobRequ
 export interface CancelSimulationJobCommandOutput extends CancelSimulationJobResponse, __MetadataBearer {}
 
 /**
- * <p>Cancels the specified simulation job.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Cancels the specified simulation job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CancelWorldExportJobCommand.ts b/clients/client-robomaker/src/commands/CancelWorldExportJobCommand.ts
@@ -28,7 +28,15 @@ export interface CancelWorldExportJobCommandInput extends CancelWorldExportJobRe
 export interface CancelWorldExportJobCommandOutput extends CancelWorldExportJobResponse, __MetadataBearer {}
 
 /**
- * <p>Cancels the specified export job.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Cancels the specified export job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CancelWorldGenerationJobCommand.ts b/clients/client-robomaker/src/commands/CancelWorldGenerationJobCommand.ts
@@ -28,7 +28,15 @@ export interface CancelWorldGenerationJobCommandInput extends CancelWorldGenerat
 export interface CancelWorldGenerationJobCommandOutput extends CancelWorldGenerationJobResponse, __MetadataBearer {}
 
 /**
- * <p>Cancels the specified world generator job.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Cancels the specified world generator job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CreateDeploymentJobCommand.ts b/clients/client-robomaker/src/commands/CreateDeploymentJobCommand.ts
@@ -28,13 +28,22 @@ export interface CreateDeploymentJobCommandInput extends CreateDeploymentJobRequ
 export interface CreateDeploymentJobCommandOutput extends CreateDeploymentJobResponse, __MetadataBearer {}
 
 /**
- * <p>Deploys a specific version of a robot application to robots in a fleet.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
  *          <important>
- *             <p>This API is no longer supported and will throw an error if used.</p>
+ *             <p>This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the <a href="https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-january2022">Support policy</a> page.</p>
  *          </important>
+ *          <p>Deploys a specific version of a robot application to robots in a fleet.</p>
  *          <p>The robot application must have a numbered <code>applicationVersion</code> for
- *          consistency reasons. To create a new version, use
- *             <code>CreateRobotApplicationVersion</code> or see <a href="https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html">Creating a Robot Application Version</a>. </p>
+ *                consistency reasons. To create a new version, use <code>CreateRobotApplicationVersion</code> or see
+ *             <a href="https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html">Creating a Robot Application Version</a>.
+ *          </p>
  *          <note>
  *             <p>After 90 days, deployment jobs expire and will be deleted. They will no longer be
  *             accessible. </p>

diff --git a/clients/client-robomaker/src/commands/CreateFleetCommand.ts b/clients/client-robomaker/src/commands/CreateFleetCommand.ts
@@ -28,10 +28,18 @@ export interface CreateFleetCommandInput extends CreateFleetRequest {}
 export interface CreateFleetCommandOutput extends CreateFleetResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a fleet, a logical group of robots running the same robot application.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
  *          <important>
- *             <p>This API is no longer supported and will throw an error if used.</p>
+ *             <p>This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the <a href="https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-january2022">Support policy</a> page.</p>
  *          </important>
+ *          <p>Creates a fleet, a logical group of robots running the same robot application.</p>
  *
  * @deprecated AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
  * @example

diff --git a/clients/client-robomaker/src/commands/CreateRobotApplicationCommand.ts b/clients/client-robomaker/src/commands/CreateRobotApplicationCommand.ts
@@ -28,7 +28,15 @@ export interface CreateRobotApplicationCommandInput extends CreateRobotApplicati
 export interface CreateRobotApplicationCommandOutput extends CreateRobotApplicationResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a robot application. </p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Creates a robot application. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CreateRobotApplicationVersionCommand.ts b/clients/client-robomaker/src/commands/CreateRobotApplicationVersionCommand.ts
@@ -33,7 +33,15 @@ export interface CreateRobotApplicationVersionCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Creates a version of a robot application.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Creates a version of a robot application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CreateRobotCommand.ts b/clients/client-robomaker/src/commands/CreateRobotCommand.ts
@@ -28,10 +28,18 @@ export interface CreateRobotCommandInput extends CreateRobotRequest {}
 export interface CreateRobotCommandOutput extends CreateRobotResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a robot.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
  *          <important>
- *             <p>This API is no longer supported and will throw an error if used.</p>
+ *             <p>This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the <a href="https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-january2022">Support policy</a> page.</p>
  *          </important>
+ *          <p>Creates a robot.</p>
  *
  * @deprecated AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
  * @example

diff --git a/clients/client-robomaker/src/commands/CreateSimulationApplicationCommand.ts b/clients/client-robomaker/src/commands/CreateSimulationApplicationCommand.ts
@@ -33,7 +33,15 @@ export interface CreateSimulationApplicationCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Creates a simulation application.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Creates a simulation application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CreateSimulationApplicationVersionCommand.ts b/clients/client-robomaker/src/commands/CreateSimulationApplicationVersionCommand.ts
@@ -36,7 +36,15 @@ export interface CreateSimulationApplicationVersionCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Creates a simulation application with a specific revision id.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Creates a simulation application with a specific revision id.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-robomaker/src/commands/CreateSimulationJobCommand.ts b/clients/client-robomaker/src/commands/CreateSimulationJobCommand.ts
@@ -28,7 +28,15 @@ export interface CreateSimulationJobCommandInput extends CreateSimulationJobRequ
 export interface CreateSimulationJobCommandOutput extends CreateSimulationJobResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a simulation job.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Creates a simulation job.</p>
  *          <note>
  *             <p>After 90 days, simulation jobs expire and will be deleted. They will no longer be
  *             accessible. </p>

diff --git a/clients/client-robomaker/src/commands/CreateWorldExportJobCommand.ts b/clients/client-robomaker/src/commands/CreateWorldExportJobCommand.ts
@@ -28,7 +28,15 @@ export interface CreateWorldExportJobCommandInput extends CreateWorldExportJobRe
 export interface CreateWorldExportJobCommandOutput extends CreateWorldExportJobResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a world export job.</p>
+ * <important>
+ *             <p>End of support notice: On September 10, 2025, Amazon Web Services
+ *          will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
+ *          no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
+ *          For more information on transitioning to Batch to help run containerized
+ *          simulations, visit <a href="https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/">https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/</a>.
+ *       </p>
+ *          </important>
+ *          <p>Creates a world export job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript