You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-emr-containers/README.md
+8-5Lines changed: 8 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,8 @@ AWS SDK for JavaScript EMRContainers Client for Node.js, Browser and React Nativ
13
13
open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With
14
14
this deployment option, you can focus on running analytics workloads while Amazon EMR on
15
15
EKS builds, configures, and manages containers for open-source applications. For more
16
-
information about Amazon EMR on EKS concepts and tasks, see <ahref="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html">What is Amazon EMR on EKS</a>.</p>
16
+
information about Amazon EMR on EKS concepts and tasks, see <ahref="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html">What is Amazon EMR on
17
+
EKS</a>.</p>
17
18
<p>
18
19
<i>Amazon EMR containers</i> is the API name for Amazon EMR on EKS. The
19
20
<code>emr-containers</code> prefix is used in the following scenarios: </p>
@@ -23,12 +24,14 @@ information about Amazon EMR on EKS concepts and tasks, see <a href="https://doc
23
24
emr-containers start-job-run</code>.</p>
24
25
</li>
25
26
<li>
26
-
<p>It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, <code>"Action": [
27
-
"emr-containers:StartJobRun"]</code>. For more information, see <ahref="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions">Policy actions for Amazon EMR on EKS</a>.</p>
27
+
<p>It is the prefix before IAM policy actions for Amazon EMR on EKS. For example,
28
+
<code>"Action": [ "emr-containers:StartJobRun"]</code>. For more information, see
29
+
<ahref="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions">Policy actions for Amazon EMR on EKS</a>.</p>
28
30
</li>
29
31
<li>
30
-
<p>It is the prefix used in Amazon EMR on EKS service endpoints. For example, <code>emr-containers.us-east-2.amazonaws.com</code>. For more
31
-
information, see <ahref="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints">Amazon EMR on EKS Service Endpoints</a>.</p>
32
+
<p>It is the prefix used in Amazon EMR on EKS service endpoints. For example,
33
+
<code>emr-containers.us-east-2.amazonaws.com</code>. For more information, see
34
+
<ahref="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints">Amazon EMR on EKS Service Endpoints</a>.</p>
Copy file name to clipboardExpand all lines: clients/client-emr-containers/src/EMRContainers.ts
+55-18Lines changed: 55 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,8 @@ import { EMRContainersClient } from "./EMRContainersClient";
71
71
* open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With
72
72
* this deployment option, you can focus on running analytics workloads while Amazon EMR on
73
73
* EKS builds, configures, and manages containers for open-source applications. For more
74
-
* information about Amazon EMR on EKS concepts and tasks, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html">What is Amazon EMR on EKS</a>.</p>
74
+
* information about Amazon EMR on EKS concepts and tasks, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html">What is Amazon EMR on
75
+
* EKS</a>.</p>
75
76
* <p>
76
77
* <i>Amazon EMR containers</i> is the API name for Amazon EMR on EKS. The
77
78
* <code>emr-containers</code> prefix is used in the following scenarios: </p>
@@ -81,18 +82,21 @@ import { EMRContainersClient } from "./EMRContainersClient";
81
82
* emr-containers start-job-run</code>.</p>
82
83
* </li>
83
84
* <li>
84
-
* <p>It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, <code>"Action": [
85
-
* "emr-containers:StartJobRun"]</code>. For more information, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions">Policy actions for Amazon EMR on EKS</a>.</p>
85
+
* <p>It is the prefix before IAM policy actions for Amazon EMR on EKS. For example,
86
+
* <code>"Action": [ "emr-containers:StartJobRun"]</code>. For more information, see
87
+
* <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions">Policy actions for Amazon EMR on EKS</a>.</p>
86
88
* </li>
87
89
* <li>
88
-
* <p>It is the prefix used in Amazon EMR on EKS service endpoints. For example, <code>emr-containers.us-east-2.amazonaws.com</code>. For more
89
-
* information, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints">Amazon EMR on EKS Service Endpoints</a>.</p>
90
+
* <p>It is the prefix used in Amazon EMR on EKS service endpoints. For example,
91
+
* <code>emr-containers.us-east-2.amazonaws.com</code>. For more information, see
92
+
* <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints">Amazon EMR on EKS Service Endpoints</a>.</p>
* <p>Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.</p>
98
+
* <p>Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or
99
+
* SparkSQL query, that you submit to Amazon EMR on EKS.</p>
96
100
*/
97
101
publiccancelJobRun(
98
102
args: CancelJobRunCommandInput,
@@ -121,7 +125,8 @@ export class EMRContainers extends EMRContainersClient {
121
125
}
122
126
123
127
/**
124
-
* <p>Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
128
+
* <p>Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to
129
+
* Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
125
130
*/
126
131
publiccreateManagedEndpoint(
127
132
args: CreateManagedEndpointCommandInput,
@@ -153,7 +158,11 @@ export class EMRContainers extends EMRContainersClient {
153
158
}
154
159
155
160
/**
156
-
* <p>Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.</p>
161
+
* <p>Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You
162
+
* can create, describe, list and delete virtual clusters. They do not consume any additional
163
+
* resource in your system. A single virtual cluster maps to a single Kubernetes namespace.
164
+
* Given this relationship, you can model virtual clusters the same way you model Kubernetes
165
+
* namespaces to meet your requirements.</p>
157
166
*/
158
167
publiccreateVirtualCluster(
159
168
args: CreateVirtualClusterCommandInput,
@@ -185,7 +194,8 @@ export class EMRContainers extends EMRContainersClient {
185
194
}
186
195
187
196
/**
188
-
* <p>Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
197
+
* <p>Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to
198
+
* Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
189
199
*/
190
200
publicdeleteManagedEndpoint(
191
201
args: DeleteManagedEndpointCommandInput,
@@ -217,7 +227,11 @@ export class EMRContainers extends EMRContainersClient {
217
227
}
218
228
219
229
/**
220
-
* <p>Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.</p>
230
+
* <p>Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You
231
+
* can create, describe, list and delete virtual clusters. They do not consume any additional
232
+
* resource in your system. A single virtual cluster maps to a single Kubernetes namespace.
233
+
* Given this relationship, you can model virtual clusters the same way you model Kubernetes
234
+
* namespaces to meet your requirements.</p>
221
235
*/
222
236
publicdeleteVirtualCluster(
223
237
args: DeleteVirtualClusterCommandInput,
@@ -249,7 +263,8 @@ export class EMRContainers extends EMRContainersClient {
249
263
}
250
264
251
265
/**
252
-
* <p>Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.</p>
266
+
* <p>Displays detailed information about a job run. A job run is a unit of work, such as a
267
+
* Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.</p>
253
268
*/
254
269
publicdescribeJobRun(
255
270
args: DescribeJobRunCommandInput,
@@ -281,7 +296,9 @@ export class EMRContainers extends EMRContainersClient {
281
296
}
282
297
283
298
/**
284
-
* <p>Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
299
+
* <p>Displays detailed information about a managed endpoint. A managed endpoint is a gateway
300
+
* that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your
301
+
* virtual cluster.</p>
285
302
*/
286
303
publicdescribeManagedEndpoint(
287
304
args: DescribeManagedEndpointCommandInput,
@@ -313,7 +330,12 @@ export class EMRContainers extends EMRContainersClient {
313
330
}
314
331
315
332
/**
316
-
* <p>Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.</p>
333
+
* <p>Displays detailed information about a specified virtual cluster. Virtual cluster is a
334
+
* managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual
335
+
* clusters. They do not consume any additional resource in your system. A single virtual
336
+
* cluster maps to a single Kubernetes namespace. Given this relationship, you can model
337
+
* virtual clusters the same way you model Kubernetes namespaces to meet your
338
+
* requirements.</p>
317
339
*/
318
340
publicdescribeVirtualCluster(
319
341
args: DescribeVirtualClusterCommandInput,
@@ -345,7 +367,8 @@ export class EMRContainers extends EMRContainersClient {
345
367
}
346
368
347
369
/**
348
-
* <p>Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.</p>
370
+
* <p>Lists job runs based on a set of parameters. A job run is a unit of work, such as a
371
+
* Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.</p>
@@ -371,7 +394,9 @@ export class EMRContainers extends EMRContainersClient {
371
394
}
372
395
373
396
/**
374
-
* <p>Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
397
+
* <p>Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway
398
+
* that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your
399
+
* virtual cluster.</p>
375
400
*/
376
401
publiclistManagedEndpoints(
377
402
args: ListManagedEndpointsCommandInput,
@@ -435,7 +460,11 @@ export class EMRContainers extends EMRContainersClient {
435
460
}
436
461
437
462
/**
438
-
* <p>Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.</p>
463
+
* <p>Lists information about the specified virtual cluster. Virtual cluster is a managed
464
+
* entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters.
465
+
* They do not consume any additional resource in your system. A single virtual cluster maps
466
+
* to a single Kubernetes namespace. Given this relationship, you can model virtual clusters
467
+
* the same way you model Kubernetes namespaces to meet your requirements.</p>
439
468
*/
440
469
publiclistVirtualClusters(
441
470
args: ListVirtualClustersCommandInput,
@@ -467,7 +496,8 @@ export class EMRContainers extends EMRContainersClient {
467
496
}
468
497
469
498
/**
470
-
* <p>Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.</p>
499
+
* <p>Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or
500
+
* SparkSQL query, that you submit to Amazon EMR on EKS.</p>
@@ -493,7 +523,14 @@ export class EMRContainers extends EMRContainersClient {
493
523
}
494
524
495
525
/**
496
-
* <p>Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.</p>
526
+
* <p>Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag
527
+
* consists of a key and an optional value, both of which you define. Tags enable you to
528
+
* categorize your AWS resources by attributes such as purpose, owner, or environment. When
529
+
* you have many resources of the same type, you can quickly identify a specific resource
530
+
* based on the tags you've assigned to it. For example, you can define a set of tags for your
531
+
* Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We
532
+
* recommend that you devise a consistent set of tag keys for each resource type. You can then
533
+
* search and filter the resources based on the tags that you add.</p>
* open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With
290
290
* this deployment option, you can focus on running analytics workloads while Amazon EMR on
291
291
* EKS builds, configures, and manages containers for open-source applications. For more
292
-
* information about Amazon EMR on EKS concepts and tasks, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html">What is Amazon EMR on EKS</a>.</p>
292
+
* information about Amazon EMR on EKS concepts and tasks, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html">What is Amazon EMR on
293
+
* EKS</a>.</p>
293
294
* <p>
294
295
* <i>Amazon EMR containers</i> is the API name for Amazon EMR on EKS. The
295
296
* <code>emr-containers</code> prefix is used in the following scenarios: </p>
* <p>It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, <code>"Action": [
303
-
* "emr-containers:StartJobRun"]</code>. For more information, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions">Policy actions for Amazon EMR on EKS</a>.</p>
303
+
* <p>It is the prefix before IAM policy actions for Amazon EMR on EKS. For example,
304
+
* <code>"Action": [ "emr-containers:StartJobRun"]</code>. For more information, see
305
+
* <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions">Policy actions for Amazon EMR on EKS</a>.</p>
304
306
* </li>
305
307
* <li>
306
-
* <p>It is the prefix used in Amazon EMR on EKS service endpoints. For example, <code>emr-containers.us-east-2.amazonaws.com</code>. For more
307
-
* information, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints">Amazon EMR on EKS Service Endpoints</a>.</p>
308
+
* <p>It is the prefix used in Amazon EMR on EKS service endpoints. For example,
309
+
* <code>emr-containers.us-east-2.amazonaws.com</code>. For more information, see
310
+
* <a href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints">Amazon EMR on EKS Service Endpoints</a>.</p>
* <p>Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
31
+
* <p>Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to
32
+
* Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.</p>
32
33
* @example
33
34
* Use a bare-bones client and the command you need to make an API call.
0 commit comments