@aws-sdk/client-codedeploy 3.181.0 → 3.183.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +42 -50
  3. package/dist-cjs/models/models_0.js +23 -18
  4. package/dist-cjs/protocols/Aws_json1_1.js +12 -0
  5. package/dist-es/CodeDeploy.js +190 -197
  6. package/dist-es/CodeDeployClient.js +22 -28
  7. package/dist-es/commands/AddTagsToOnPremisesInstancesCommand.js +22 -29
  8. package/dist-es/commands/BatchGetApplicationRevisionsCommand.js +21 -28
  9. package/dist-es/commands/BatchGetApplicationsCommand.js +21 -28
  10. package/dist-es/commands/BatchGetDeploymentGroupsCommand.js +21 -28
  11. package/dist-es/commands/BatchGetDeploymentInstancesCommand.js +21 -28
  12. package/dist-es/commands/BatchGetDeploymentTargetsCommand.js +21 -28
  13. package/dist-es/commands/BatchGetDeploymentsCommand.js +21 -28
  14. package/dist-es/commands/BatchGetOnPremisesInstancesCommand.js +21 -28
  15. package/dist-es/commands/ContinueDeploymentCommand.js +22 -29
  16. package/dist-es/commands/CreateApplicationCommand.js +21 -28
  17. package/dist-es/commands/CreateDeploymentCommand.js +21 -28
  18. package/dist-es/commands/CreateDeploymentConfigCommand.js +21 -28
  19. package/dist-es/commands/CreateDeploymentGroupCommand.js +21 -28
  20. package/dist-es/commands/DeleteApplicationCommand.js +22 -29
  21. package/dist-es/commands/DeleteDeploymentConfigCommand.js +22 -29
  22. package/dist-es/commands/DeleteDeploymentGroupCommand.js +21 -28
  23. package/dist-es/commands/DeleteGitHubAccountTokenCommand.js +21 -28
  24. package/dist-es/commands/DeleteResourcesByExternalIdCommand.js +21 -28
  25. package/dist-es/commands/DeregisterOnPremisesInstanceCommand.js +22 -29
  26. package/dist-es/commands/GetApplicationCommand.js +21 -28
  27. package/dist-es/commands/GetApplicationRevisionCommand.js +21 -28
  28. package/dist-es/commands/GetDeploymentCommand.js +21 -28
  29. package/dist-es/commands/GetDeploymentConfigCommand.js +21 -28
  30. package/dist-es/commands/GetDeploymentGroupCommand.js +21 -28
  31. package/dist-es/commands/GetDeploymentInstanceCommand.js +21 -28
  32. package/dist-es/commands/GetDeploymentTargetCommand.js +21 -28
  33. package/dist-es/commands/GetOnPremisesInstanceCommand.js +21 -28
  34. package/dist-es/commands/ListApplicationRevisionsCommand.js +21 -28
  35. package/dist-es/commands/ListApplicationsCommand.js +21 -28
  36. package/dist-es/commands/ListDeploymentConfigsCommand.js +21 -28
  37. package/dist-es/commands/ListDeploymentGroupsCommand.js +21 -28
  38. package/dist-es/commands/ListDeploymentInstancesCommand.js +21 -28
  39. package/dist-es/commands/ListDeploymentTargetsCommand.js +21 -28
  40. package/dist-es/commands/ListDeploymentsCommand.js +21 -28
  41. package/dist-es/commands/ListGitHubAccountTokenNamesCommand.js +21 -28
  42. package/dist-es/commands/ListOnPremisesInstancesCommand.js +21 -28
  43. package/dist-es/commands/ListTagsForResourceCommand.js +21 -28
  44. package/dist-es/commands/PutLifecycleEventHookExecutionStatusCommand.js +21 -28
  45. package/dist-es/commands/RegisterApplicationRevisionCommand.js +22 -29
  46. package/dist-es/commands/RegisterOnPremisesInstanceCommand.js +22 -29
  47. package/dist-es/commands/RemoveTagsFromOnPremisesInstancesCommand.js +22 -29
  48. package/dist-es/commands/SkipWaitTimeForInstanceTerminationCommand.js +22 -29
  49. package/dist-es/commands/StopDeploymentCommand.js +21 -28
  50. package/dist-es/commands/TagResourceCommand.js +21 -28
  51. package/dist-es/commands/UntagResourceCommand.js +21 -28
  52. package/dist-es/commands/UpdateApplicationCommand.js +22 -29
  53. package/dist-es/commands/UpdateDeploymentGroupCommand.js +21 -28
  54. package/dist-es/endpoints.js +8 -8
  55. package/dist-es/models/CodeDeployServiceException.js +5 -10
  56. package/dist-es/models/models_0.js +1727 -1447
  57. package/dist-es/pagination/ListApplicationRevisionsPaginator.js +24 -67
  58. package/dist-es/pagination/ListApplicationsPaginator.js +24 -67
  59. package/dist-es/pagination/ListDeploymentConfigsPaginator.js +24 -67
  60. package/dist-es/pagination/ListDeploymentGroupsPaginator.js +24 -67
  61. package/dist-es/pagination/ListDeploymentInstancesPaginator.js +24 -67
  62. package/dist-es/pagination/ListDeploymentsPaginator.js +24 -67
  63. package/dist-es/protocols/Aws_json1_1.js +4823 -5800
  64. package/dist-es/runtimeConfig.browser.js +26 -12
  65. package/dist-es/runtimeConfig.js +30 -12
  66. package/dist-es/runtimeConfig.native.js +8 -5
  67. package/dist-es/runtimeConfig.shared.js +8 -11
  68. package/dist-es/waiters/waitForDeploymentSuccessful.js +45 -65
  69. package/dist-types/CodeDeploy.d.ts +71 -79
  70. package/dist-types/CodeDeployClient.d.ts +42 -49
  71. package/dist-types/commands/BatchGetDeploymentInstancesCommand.d.ts +1 -1
  72. package/dist-types/commands/BatchGetDeploymentTargetsCommand.d.ts +7 -8
  73. package/dist-types/commands/ListApplicationsCommand.d.ts +1 -1
  74. package/dist-types/commands/ListDeploymentConfigsCommand.d.ts +1 -1
  75. package/dist-types/commands/ListDeploymentGroupsCommand.d.ts +2 -2
  76. package/dist-types/commands/ListDeploymentInstancesCommand.d.ts +4 -3
  77. package/dist-types/commands/ListDeploymentsCommand.d.ts +2 -2
  78. package/dist-types/commands/PutLifecycleEventHookExecutionStatusCommand.d.ts +9 -9
  79. package/dist-types/commands/RegisterApplicationRevisionCommand.d.ts +1 -1
  80. package/dist-types/commands/RegisterOnPremisesInstanceCommand.d.ts +1 -2
  81. package/dist-types/models/models_0.d.ts +375 -352
  82. package/dist-types/ts3.4/models/models_0.d.ts +13 -8
  83. package/package.json +34 -34
@@ -173,30 +173,29 @@ declare type CodeDeployClientResolvedConfigType = __SmithyResolvedConfiguration<
173
173
  export interface CodeDeployClientResolvedConfig extends CodeDeployClientResolvedConfigType {
174
174
  }
175
175
  /**
176
- * <fullname>AWS CodeDeploy</fullname>
177
- * <p>AWS CodeDeploy is a deployment service that automates application deployments to
178
- * Amazon EC2 instances, on-premises instances running in your own facility, serverless AWS
179
- * Lambda functions, or applications in an Amazon ECS service.</p>
176
+ * <p>CodeDeploy is a deployment service that automates application deployments
177
+ * to Amazon EC2 instances, on-premises instances running in your own facility,
178
+ * serverless Lambda functions, or applications in an Amazon ECS
179
+ * service.</p>
180
180
  * <p>You can deploy a nearly unlimited variety of application content, such as an updated
181
- * Lambda function, updated applications in an Amazon ECS service, code, web and
182
- * configuration files, executables, packages, scripts, multimedia files, and so on. AWS
183
- * CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub
184
- * repositories, or Bitbucket repositories. You do not need to make changes to your
185
- * existing code before you can use AWS CodeDeploy.</p>
186
- * <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you
187
- * avoid downtime during application deployment, and handles the complexity of updating
181
+ * Lambda function, updated applications in an Amazon ECS service,
182
+ * code, web and configuration files, executables, packages, scripts, multimedia files, and
183
+ * so on. CodeDeploy can deploy application content stored in Amazon S3
184
+ * buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes
185
+ * to your existing code before you can use CodeDeploy.</p>
186
+ * <p>CodeDeploy makes it easier for you to rapidly release new features, helps
187
+ * you avoid downtime during application deployment, and handles the complexity of updating
188
188
  * your applications, without many of the risks associated with error-prone manual
189
189
  * deployments.</p>
190
190
  * <p>
191
- * <b>AWS CodeDeploy Components</b>
191
+ * <b>CodeDeploy Components</b>
192
192
  * </p>
193
- * <p>Use the information in this guide to help you work with the following AWS CodeDeploy
194
- * components:</p>
193
+ * <p>Use the information in this guide to help you work with the following CodeDeploy components:</p>
195
194
  * <ul>
196
195
  * <li>
197
196
  * <p>
198
197
  * <b>Application</b>: A name that uniquely identifies
199
- * the application you want to deploy. AWS CodeDeploy uses this name, which
198
+ * the application you want to deploy. CodeDeploy uses this name, which
200
199
  * functions as a container, to ensure the correct combination of revision,
201
200
  * deployment configuration, and deployment group are referenced during a
202
201
  * deployment.</p>
@@ -204,72 +203,66 @@ export interface CodeDeployClientResolvedConfig extends CodeDeployClientResolved
204
203
  * <li>
205
204
  * <p>
206
205
  * <b>Deployment group</b>: A set of individual
207
- * instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS
208
- * service and network details. A Lambda deployment group specifies how to route
209
- * traffic to a new version of a Lambda function. An Amazon ECS deployment group
210
- * specifies the service created in Amazon ECS to deploy, a load balancer, and a
211
- * listener to reroute production traffic to an updated containerized application.
212
- * An EC2/On-premises deployment group contains individually tagged instances,
213
- * Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment
214
- * groups can specify optional trigger, alarm, and rollback settings.</p>
206
+ * instances, CodeDeploy
207
+ * Lambda deployment configuration settings, or an Amazon ECS
208
+ * service and network details. A Lambda deployment group specifies how
209
+ * to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production
210
+ * traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All
211
+ * deployment groups can specify optional trigger, alarm, and rollback
212
+ * settings.</p>
215
213
  * </li>
216
214
  * <li>
217
215
  * <p>
218
216
  * <b>Deployment configuration</b>: A set of deployment
219
- * rules and deployment success and failure conditions used by AWS CodeDeploy
220
- * during a deployment.</p>
217
+ * rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p>
221
218
  * </li>
222
219
  * <li>
223
220
  * <p>
224
221
  * <b>Deployment</b>: The process and the components used
225
- * when updating a Lambda function, a containerized application in an Amazon ECS
226
- * service, or of installing content on one or more instances. </p>
222
+ * when updating a Lambda function, a containerized application in an
223
+ * Amazon ECS service, or of installing content on one or more
224
+ * instances. </p>
227
225
  * </li>
228
226
  * <li>
229
227
  * <p>
230
- * <b>Application revisions</b>: For an AWS Lambda
231
- * deployment, this is an AppSpec file that specifies the Lambda function to be
232
- * updated and one or more functions to validate deployment lifecycle events. For
233
- * an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS
234
- * task definition, container, and port where production traffic is rerouted. For
235
- * an EC2/On-premises deployment, this is an archive file that contains source
236
- * content—source code, webpages, executable files, and deployment scripts—along
237
- * with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub
238
- * repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3
239
- * object key and its ETag, version, or both. For GitHub, a revision is uniquely
228
+ * <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the
229
+ * Lambda function to be updated and one or more functions to
230
+ * validate deployment lifecycle events. For an Amazon ECS deployment, this
231
+ * is an AppSpec file that specifies the Amazon ECS task definition,
232
+ * container, and port where production traffic is rerouted. For an EC2/On-premises
233
+ * deployment, this is an archive file that contains source content—source code,
234
+ * webpages, executable files, and deployment scripts—along with an AppSpec file.
235
+ * Revisions are stored in Amazon S3 buckets or GitHub repositories. For
236
+ * Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely
240
237
  * identified by its commit ID.</p>
241
238
  * </li>
242
239
  * </ul>
243
240
  * <p>This guide also contains information to help you get details about the instances in
244
- * your deployments, to make on-premises instances available for AWS CodeDeploy
245
- * deployments, to get details about a Lambda function deployment, and to get details about
246
- * Amazon ECS service deployments.</p>
241
+ * your deployments, to make on-premises instances available for CodeDeploy
242
+ * deployments, to get details about a Lambda function deployment, and to get
243
+ * details about Amazon ECS service deployments.</p>
247
244
  * <p>
248
- * <b>AWS CodeDeploy Information Resources</b>
245
+ * <b>CodeDeploy Information Resources</b>
249
246
  * </p>
250
247
  * <ul>
251
248
  * <li>
252
249
  * <p>
253
- * <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">AWS CodeDeploy
254
- * User Guide</a>
250
+ * <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a>
255
251
  * </p>
256
252
  * </li>
257
253
  * <li>
258
254
  * <p>
259
- * <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">AWS
260
- * CodeDeploy API Reference Guide</a>
255
+ * <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">CodeDeploy API Reference Guide</a>
261
256
  * </p>
262
257
  * </li>
263
258
  * <li>
264
259
  * <p>
265
- * <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">AWS
266
- * CLI Reference for AWS CodeDeploy</a>
260
+ * <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">CLI Reference for CodeDeploy</a>
267
261
  * </p>
268
262
  * </li>
269
263
  * <li>
270
264
  * <p>
271
- * <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">AWS CodeDeploy
272
- * Developer Forum</a>
265
+ * <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">CodeDeploy Developer Forum</a>
273
266
  * </p>
274
267
  * </li>
275
268
  * </ul>
@@ -14,7 +14,7 @@ export interface BatchGetDeploymentInstancesCommandOutput extends BatchGetDeploy
14
14
  * instead. </p>
15
15
  * </note>
16
16
  * <p> Returns an array of one or more instances associated with a deployment. This method
17
- * works with EC2/On-premises and AWS Lambda compute platforms. The newer
17
+ * works with EC2/On-premises and Lambda compute platforms. The newer
18
18
  * <code>BatchGetDeploymentTargets</code> works with all compute platforms. The maximum
19
19
  * number of instances that can be returned is 25.</p>
20
20
  * @example
@@ -16,23 +16,22 @@ export interface BatchGetDeploymentTargetsCommandOutput extends BatchGetDeployme
16
16
  * <ul>
17
17
  * <li>
18
18
  * <p>
19
- * <b>EC2/On-premises</b>: Information about EC2 instance
20
- * targets. </p>
19
+ * <b>EC2/On-premises</b>: Information about Amazon EC2 instance targets. </p>
21
20
  * </li>
22
21
  * <li>
23
22
  * <p>
24
- * <b>AWS Lambda</b>: Information about Lambda functions
25
- * targets. </p>
23
+ * <b>Lambda</b>: Information about
24
+ * Lambda functions targets. </p>
26
25
  * </li>
27
26
  * <li>
28
27
  * <p>
29
- * <b>Amazon ECS</b>: Information about Amazon ECS
30
- * service targets. </p>
28
+ * <b>Amazon ECS</b>: Information about Amazon ECS service targets. </p>
31
29
  * </li>
32
30
  * <li>
33
31
  * <p>
34
- * <b>CloudFormation</b>: Information about targets of
35
- * blue/green deployments initiated by a CloudFormation stack update.</p>
32
+ * <b>CloudFormation</b>: Information about
33
+ * targets of blue/green deployments initiated by a CloudFormation stack
34
+ * update.</p>
36
35
  * </li>
37
36
  * </ul>
38
37
  * @example
@@ -7,7 +7,7 @@ export interface ListApplicationsCommandInput extends ListApplicationsInput {
7
7
  export interface ListApplicationsCommandOutput extends ListApplicationsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the applications registered with the IAM user or AWS account.</p>
10
+ * <p>Lists the applications registered with the IAM user or Amazon Web Services account.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,7 +7,7 @@ export interface ListDeploymentConfigsCommandInput extends ListDeploymentConfigs
7
7
  export interface ListDeploymentConfigsCommandOutput extends ListDeploymentConfigsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the deployment configurations with the IAM user or AWS account.</p>
10
+ * <p>Lists the deployment configurations with the IAM user or Amazon Web Services account.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,8 +7,8 @@ export interface ListDeploymentGroupsCommandInput extends ListDeploymentGroupsIn
7
7
  export interface ListDeploymentGroupsCommandOutput extends ListDeploymentGroupsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the deployment groups for an application registered with the IAM user or AWS
11
- * account.</p>
10
+ * <p>Lists the deployment groups for an application registered with the IAM
11
+ * user or Amazon Web Services account.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -12,10 +12,11 @@ export interface ListDeploymentInstancesCommandOutput extends ListDeploymentInst
12
12
  * <note>
13
13
  * <p> The newer <code>BatchGetDeploymentTargets</code> should be used instead because
14
14
  * it works with all compute types. <code>ListDeploymentInstances</code> throws an
15
- * exception if it is used with a compute platform other than EC2/On-premises or AWS
16
- * Lambda. </p>
15
+ * exception if it is used with a compute platform other than EC2/On-premises or
16
+ * Lambda. </p>
17
17
  * </note>
18
- * <p> Lists the instance for a deployment associated with the IAM user or AWS account. </p>
18
+ * <p> Lists the instance for a deployment associated with the IAM user or
19
+ * Amazon Web Services account. </p>
19
20
  * @example
20
21
  * Use a bare-bones client and the command you need to make an API call.
21
22
  * ```javascript
@@ -7,8 +7,8 @@ export interface ListDeploymentsCommandInput extends ListDeploymentsInput {
7
7
  export interface ListDeploymentsCommandOutput extends ListDeploymentsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the deployments in a deployment group for an application registered with the IAM
11
- * user or AWS account.</p>
10
+ * <p>Lists the deployments in a deployment group for an application registered with the
11
+ * IAM user or Amazon Web Services account.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -7,15 +7,15 @@ export interface PutLifecycleEventHookExecutionStatusCommandInput extends PutLif
7
7
  export interface PutLifecycleEventHookExecutionStatusCommandOutput extends PutLifecycleEventHookExecutionStatusOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p> Sets the result of a Lambda validation function. The function validates lifecycle
11
- * hooks during a deployment that uses the AWS Lambda or Amazon ECS compute platform. For
12
- * AWS Lambda deployments, the available lifecycle hooks are
13
- * <code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>. For Amazon ECS
14
- * deployments, the available lifecycle hooks are <code>BeforeInstall</code>,
15
- * <code>AfterInstall</code>, <code>AfterAllowTestTraffic</code>,
16
- * <code>BeforeAllowTraffic</code>, and <code>AfterAllowTraffic</code>. Lambda
17
- * validation functions return <code>Succeeded</code> or <code>Failed</code>. For more
18
- * information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda">AppSpec 'hooks' Section for an AWS Lambda Deployment </a> and <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs">AppSpec 'hooks' Section for an Amazon ECS Deployment</a>.</p>
10
+ * <p> Sets the result of a Lambda validation function. The function validates
11
+ * lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available
12
+ * lifecycle hooks are <code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>.
13
+ * For Amazon ECS deployments, the available lifecycle hooks are
14
+ * <code>BeforeInstall</code>, <code>AfterInstall</code>,
15
+ * <code>AfterAllowTestTraffic</code>, <code>BeforeAllowTraffic</code>, and
16
+ * <code>AfterAllowTraffic</code>. Lambda validation functions return
17
+ * <code>Succeeded</code> or <code>Failed</code>. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda">AppSpec 'hooks' Section for an Lambda Deployment </a> and
18
+ * <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs">AppSpec 'hooks' Section for an Amazon ECS Deployment</a>.</p>
19
19
  * @example
20
20
  * Use a bare-bones client and the command you need to make an API call.
21
21
  * ```javascript
@@ -7,7 +7,7 @@ export interface RegisterApplicationRevisionCommandInput extends RegisterApplica
7
7
  export interface RegisterApplicationRevisionCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Registers with AWS CodeDeploy a revision for the specified application.</p>
10
+ * <p>Registers with CodeDeploy a revision for the specified application.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -9,8 +9,7 @@ export interface RegisterOnPremisesInstanceCommandOutput extends __MetadataBeare
9
9
  /**
10
10
  * <p>Registers an on-premises instance.</p>
11
11
  * <note>
12
- * <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request.
13
- * You cannot use both.</p>
12
+ * <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.</p>
14
13
  * </note>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.