Skip to content

Commit bc47ba4

Browse files
author
awstools
committed
docs(client-robomaker): Documentation update: added support notices to each API action.
1 parent 9d746f6 commit bc47ba4

File tree

59 files changed

+639
-179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+639
-179
lines changed

clients/client-robomaker/src/commands/BatchDeleteWorldsCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface BatchDeleteWorldsCommandInput extends BatchDeleteWorldsRequest
2828
export interface BatchDeleteWorldsCommandOutput extends BatchDeleteWorldsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes one or more worlds in a batch operation.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Deletes one or more worlds in a batch operation.</p>
3240
* @example
3341
* Use a bare-bones client and the command you need to make an API call.
3442
* ```javascript

clients/client-robomaker/src/commands/BatchDescribeSimulationJobCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface BatchDescribeSimulationJobCommandInput extends BatchDescribeSim
2828
export interface BatchDescribeSimulationJobCommandOutput extends BatchDescribeSimulationJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Describes one or more simulation jobs.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Describes one or more simulation jobs.</p>
3240
* @example
3341
* Use a bare-bones client and the command you need to make an API call.
3442
* ```javascript

clients/client-robomaker/src/commands/CancelDeploymentJobCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ export interface CancelDeploymentJobCommandInput extends CancelDeploymentJobRequ
2828
export interface CancelDeploymentJobCommandOutput extends CancelDeploymentJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Cancels the specified deployment job.</p>
32-
* <important>
33-
* <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>
31+
* <important>
32+
* <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>
3433
* </important>
34+
* <p>Cancels the specified deployment job.</p>
3535
*
3636
* @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.
3737
* @example

clients/client-robomaker/src/commands/CancelSimulationJobBatchCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface CancelSimulationJobBatchCommandInput extends CancelSimulationJo
2828
export interface CancelSimulationJobBatchCommandOutput extends CancelSimulationJobBatchResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Cancels a simulation job batch. When you cancel a simulation job batch, you are also
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Cancels a simulation job batch. When you cancel a simulation job batch, you are also
3240
* cancelling all of the active simulation jobs created as part of the batch. </p>
3341
* @example
3442
* Use a bare-bones client and the command you need to make an API call.

clients/client-robomaker/src/commands/CancelSimulationJobCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface CancelSimulationJobCommandInput extends CancelSimulationJobRequ
2828
export interface CancelSimulationJobCommandOutput extends CancelSimulationJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Cancels the specified simulation job.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Cancels the specified simulation job.</p>
3240
* @example
3341
* Use a bare-bones client and the command you need to make an API call.
3442
* ```javascript

clients/client-robomaker/src/commands/CancelWorldExportJobCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface CancelWorldExportJobCommandInput extends CancelWorldExportJobRe
2828
export interface CancelWorldExportJobCommandOutput extends CancelWorldExportJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Cancels the specified export job.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Cancels the specified export job.</p>
3240
* @example
3341
* Use a bare-bones client and the command you need to make an API call.
3442
* ```javascript

clients/client-robomaker/src/commands/CancelWorldGenerationJobCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface CancelWorldGenerationJobCommandInput extends CancelWorldGenerat
2828
export interface CancelWorldGenerationJobCommandOutput extends CancelWorldGenerationJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Cancels the specified world generator job.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Cancels the specified world generator job.</p>
3240
* @example
3341
* Use a bare-bones client and the command you need to make an API call.
3442
* ```javascript

clients/client-robomaker/src/commands/CreateDeploymentJobCommand.ts

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,22 @@ export interface CreateDeploymentJobCommandInput extends CreateDeploymentJobRequ
2828
export interface CreateDeploymentJobCommandOutput extends CreateDeploymentJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deploys a specific version of a robot application to robots in a fleet.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
3239
* <important>
33-
* <p>This API is no longer supported and will throw an error if used.</p>
40+
* <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>
3441
* </important>
42+
* <p>Deploys a specific version of a robot application to robots in a fleet.</p>
3543
* <p>The robot application must have a numbered <code>applicationVersion</code> for
36-
* consistency reasons. To create a new version, use
37-
* <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>
44+
* consistency reasons. To create a new version, use <code>CreateRobotApplicationVersion</code> or see
45+
* <a href="https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html">Creating a Robot Application Version</a>.
46+
* </p>
3847
* <note>
3948
* <p>After 90 days, deployment jobs expire and will be deleted. They will no longer be
4049
* accessible. </p>

clients/client-robomaker/src/commands/CreateFleetCommand.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,18 @@ export interface CreateFleetCommandInput extends CreateFleetRequest {}
2828
export interface CreateFleetCommandOutput extends CreateFleetResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a fleet, a logical group of robots running the same robot application.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
3239
* <important>
33-
* <p>This API is no longer supported and will throw an error if used.</p>
40+
* <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>
3441
* </important>
42+
* <p>Creates a fleet, a logical group of robots running the same robot application.</p>
3543
*
3644
* @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.
3745
* @example

clients/client-robomaker/src/commands/CreateRobotApplicationCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface CreateRobotApplicationCommandInput extends CreateRobotApplicati
2828
export interface CreateRobotApplicationCommandOutput extends CreateRobotApplicationResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a robot application. </p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Creates a robot application. </p>
3240
* @example
3341
* Use a bare-bones client and the command you need to make an API call.
3442
* ```javascript

clients/client-robomaker/src/commands/CreateRobotApplicationVersionCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ export interface CreateRobotApplicationVersionCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Creates a version of a robot application.</p>
36+
* <important>
37+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
38+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
39+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
40+
* For more information on transitioning to Batch to help run containerized
41+
* 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>.
42+
* </p>
43+
* </important>
44+
* <p>Creates a version of a robot application.</p>
3745
* @example
3846
* Use a bare-bones client and the command you need to make an API call.
3947
* ```javascript

clients/client-robomaker/src/commands/CreateRobotCommand.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,18 @@ export interface CreateRobotCommandInput extends CreateRobotRequest {}
2828
export interface CreateRobotCommandOutput extends CreateRobotResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a robot.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
3239
* <important>
33-
* <p>This API is no longer supported and will throw an error if used.</p>
40+
* <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>
3441
* </important>
42+
* <p>Creates a robot.</p>
3543
*
3644
* @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.
3745
* @example

clients/client-robomaker/src/commands/CreateSimulationApplicationCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ export interface CreateSimulationApplicationCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Creates a simulation application.</p>
36+
* <important>
37+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
38+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
39+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
40+
* For more information on transitioning to Batch to help run containerized
41+
* 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>.
42+
* </p>
43+
* </important>
44+
* <p>Creates a simulation application.</p>
3745
* @example
3846
* Use a bare-bones client and the command you need to make an API call.
3947
* ```javascript

clients/client-robomaker/src/commands/CreateSimulationApplicationVersionCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,15 @@ export interface CreateSimulationApplicationVersionCommandOutput
3636
__MetadataBearer {}
3737

3838
/**
39-
* <p>Creates a simulation application with a specific revision id.</p>
39+
* <important>
40+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
41+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
42+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
43+
* For more information on transitioning to Batch to help run containerized
44+
* 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>.
45+
* </p>
46+
* </important>
47+
* <p>Creates a simulation application with a specific revision id.</p>
4048
* @example
4149
* Use a bare-bones client and the command you need to make an API call.
4250
* ```javascript

clients/client-robomaker/src/commands/CreateSimulationJobCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface CreateSimulationJobCommandInput extends CreateSimulationJobRequ
2828
export interface CreateSimulationJobCommandOutput extends CreateSimulationJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a simulation job.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Creates a simulation job.</p>
3240
* <note>
3341
* <p>After 90 days, simulation jobs expire and will be deleted. They will no longer be
3442
* accessible. </p>

clients/client-robomaker/src/commands/CreateWorldExportJobCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ export interface CreateWorldExportJobCommandInput extends CreateWorldExportJobRe
2828
export interface CreateWorldExportJobCommandOutput extends CreateWorldExportJobResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a world export job.</p>
31+
* <important>
32+
* <p>End of support notice: On September 10, 2025, Amazon Web Services
33+
* will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will
34+
* no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources.
35+
* For more information on transitioning to Batch to help run containerized
36+
* 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>.
37+
* </p>
38+
* </important>
39+
* <p>Creates a world export job.</p>
3240
* @example
3341
* Use a bare-bones client and the command you need to make an API call.
3442
* ```javascript

0 commit comments

Comments
 (0)