@aws-sdk/client-batch 3.295.0 → 3.297.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 (35) hide show
  1. package/dist-types/Batch.d.ts +25 -0
  2. package/dist-types/BatchClient.d.ts +24 -4
  3. package/dist-types/commands/CancelJobCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateJobQueueCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateSchedulingPolicyCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteJobQueueCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteSchedulingPolicyCommand.d.ts +16 -0
  10. package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeJobQueuesCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeJobsCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeSchedulingPoliciesCommand.d.ts +16 -0
  16. package/dist-types/commands/ListJobsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListSchedulingPoliciesCommand.d.ts +16 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +16 -0
  20. package/dist-types/commands/SubmitJobCommand.d.ts +16 -0
  21. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/TerminateJobCommand.d.ts +16 -0
  23. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateJobQueueCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateSchedulingPolicyCommand.d.ts +16 -0
  27. package/dist-types/models/BatchServiceException.d.ts +2 -0
  28. package/dist-types/models/models_0.d.ts +236 -5
  29. package/dist-types/pagination/DescribeComputeEnvironmentsPaginator.d.ts +3 -0
  30. package/dist-types/pagination/DescribeJobDefinitionsPaginator.d.ts +3 -0
  31. package/dist-types/pagination/DescribeJobQueuesPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListJobsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListSchedulingPoliciesPaginator.d.ts +3 -0
  35. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { DeregisterJobDefinitionRequest, DeregisterJobDefinitionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeregisterJobDefinitionCommand}.
8
10
  */
9
11
  export interface DeregisterJobDefinitionCommandInput extends DeregisterJobDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeregisterJobDefinitionCommand}.
13
17
  */
14
18
  export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefinitionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefin
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeregisterJobDefinitionCommandInput - {@link DeregisterJobDefinitionCommandInput}
34
+ * @returns {@link DeregisterJobDefinitionCommandOutput}
28
35
  * @see {@link DeregisterJobDefinitionCommandInput} for command's `input` shape.
29
36
  * @see {@link DeregisterJobDefinitionCommandOutput} for command's `response` shape.
30
37
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefin
53
60
  export declare class DeregisterJobDefinitionCommand extends $Command<DeregisterJobDefinitionCommandInput, DeregisterJobDefinitionCommandOutput, BatchClientResolvedConfig> {
54
61
  readonly input: DeregisterJobDefinitionCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DeregisterJobDefinitionCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeregisterJobDefinitionCommandInput, DeregisterJobDefinitionCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { DescribeComputeEnvironmentsRequest, DescribeComputeEnvironmentsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeComputeEnvironmentsCommand}.
8
10
  */
9
11
  export interface DescribeComputeEnvironmentsCommandInput extends DescribeComputeEnvironmentsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeComputeEnvironmentsCommand}.
13
17
  */
14
18
  export interface DescribeComputeEnvironmentsCommandOutput extends DescribeComputeEnvironmentsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes one or more of your compute environments.</p>
18
23
  * <p>If you're using an unmanaged compute environment, you can use the <code>DescribeComputeEnvironment</code>
19
24
  * operation to determine the <code>ecsClusterArn</code> that you launch your Amazon ECS container instances
@@ -28,6 +33,8 @@ export interface DescribeComputeEnvironmentsCommandOutput extends DescribeComput
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeComputeEnvironmentsCommandInput - {@link DescribeComputeEnvironmentsCommandInput}
37
+ * @returns {@link DescribeComputeEnvironmentsCommandOutput}
31
38
  * @see {@link DescribeComputeEnvironmentsCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeComputeEnvironmentsCommandOutput} for command's `response` shape.
33
40
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -96,11 +103,20 @@ export interface DescribeComputeEnvironmentsCommandOutput extends DescribeComput
96
103
  export declare class DescribeComputeEnvironmentsCommand extends $Command<DescribeComputeEnvironmentsCommandInput, DescribeComputeEnvironmentsCommandOutput, BatchClientResolvedConfig> {
97
104
  readonly input: DescribeComputeEnvironmentsCommandInput;
98
105
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
106
+ /**
107
+ * @public
108
+ */
99
109
  constructor(input: DescribeComputeEnvironmentsCommandInput);
100
110
  /**
101
111
  * @internal
102
112
  */
103
113
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeComputeEnvironmentsCommandInput, DescribeComputeEnvironmentsCommandOutput>;
114
+ /**
115
+ * @internal
116
+ */
104
117
  private serialize;
118
+ /**
119
+ * @internal
120
+ */
105
121
  private deserialize;
106
122
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { DescribeJobDefinitionsRequest, DescribeJobDefinitionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeJobDefinitionsCommand}.
8
10
  */
9
11
  export interface DescribeJobDefinitionsCommandInput extends DescribeJobDefinitionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeJobDefinitionsCommand}.
13
17
  */
14
18
  export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefinitionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only
18
23
  * return job definitions that match that status.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeJobDefinitionsCommandInput - {@link DescribeJobDefinitionsCommandInput}
35
+ * @returns {@link DescribeJobDefinitionsCommandOutput}
29
36
  * @see {@link DescribeJobDefinitionsCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeJobDefinitionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -88,11 +95,20 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
88
95
  export declare class DescribeJobDefinitionsCommand extends $Command<DescribeJobDefinitionsCommandInput, DescribeJobDefinitionsCommandOutput, BatchClientResolvedConfig> {
89
96
  readonly input: DescribeJobDefinitionsCommandInput;
90
97
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
98
+ /**
99
+ * @public
100
+ */
91
101
  constructor(input: DescribeJobDefinitionsCommandInput);
92
102
  /**
93
103
  * @internal
94
104
  */
95
105
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeJobDefinitionsCommandInput, DescribeJobDefinitionsCommandOutput>;
106
+ /**
107
+ * @internal
108
+ */
96
109
  private serialize;
110
+ /**
111
+ * @internal
112
+ */
97
113
  private deserialize;
98
114
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { DescribeJobQueuesRequest, DescribeJobQueuesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeJobQueuesCommand}.
8
10
  */
9
11
  export interface DescribeJobQueuesCommandInput extends DescribeJobQueuesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeJobQueuesCommand}.
13
17
  */
14
18
  export interface DescribeJobQueuesCommandOutput extends DescribeJobQueuesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes one or more of your job queues.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeJobQueuesCommandOutput extends DescribeJobQueuesRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeJobQueuesCommandInput - {@link DescribeJobQueuesCommandInput}
34
+ * @returns {@link DescribeJobQueuesCommandOutput}
28
35
  * @see {@link DescribeJobQueuesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeJobQueuesCommandOutput} for command's `response` shape.
30
37
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -75,11 +82,20 @@ export interface DescribeJobQueuesCommandOutput extends DescribeJobQueuesRespons
75
82
  export declare class DescribeJobQueuesCommand extends $Command<DescribeJobQueuesCommandInput, DescribeJobQueuesCommandOutput, BatchClientResolvedConfig> {
76
83
  readonly input: DescribeJobQueuesCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: DescribeJobQueuesCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeJobQueuesCommandInput, DescribeJobQueuesCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { DescribeJobsRequest, DescribeJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeJobsCommand}.
8
10
  */
9
11
  export interface DescribeJobsCommandInput extends DescribeJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeJobsCommand}.
13
17
  */
14
18
  export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a list of Batch jobs.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeJobsCommandInput - {@link DescribeJobsCommandInput}
34
+ * @returns {@link DescribeJobsCommandOutput}
28
35
  * @see {@link DescribeJobsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeJobsCommandOutput} for command's `response` shape.
30
37
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -88,11 +95,20 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
88
95
  export declare class DescribeJobsCommand extends $Command<DescribeJobsCommandInput, DescribeJobsCommandOutput, BatchClientResolvedConfig> {
89
96
  readonly input: DescribeJobsCommandInput;
90
97
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
98
+ /**
99
+ * @public
100
+ */
91
101
  constructor(input: DescribeJobsCommandInput);
92
102
  /**
93
103
  * @internal
94
104
  */
95
105
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeJobsCommandInput, DescribeJobsCommandOutput>;
106
+ /**
107
+ * @internal
108
+ */
96
109
  private serialize;
110
+ /**
111
+ * @internal
112
+ */
97
113
  private deserialize;
98
114
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { DescribeSchedulingPoliciesRequest, DescribeSchedulingPoliciesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeSchedulingPoliciesCommand}.
8
10
  */
9
11
  export interface DescribeSchedulingPoliciesCommandInput extends DescribeSchedulingPoliciesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeSchedulingPoliciesCommand}.
13
17
  */
14
18
  export interface DescribeSchedulingPoliciesCommandOutput extends DescribeSchedulingPoliciesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes one or more of your scheduling policies.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeSchedulingPoliciesCommandOutput extends DescribeSchedul
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeSchedulingPoliciesCommandInput - {@link DescribeSchedulingPoliciesCommandInput}
34
+ * @returns {@link DescribeSchedulingPoliciesCommandOutput}
28
35
  * @see {@link DescribeSchedulingPoliciesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeSchedulingPoliciesCommandOutput} for command's `response` shape.
30
37
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeSchedulingPoliciesCommandOutput extends DescribeSchedul
42
49
  export declare class DescribeSchedulingPoliciesCommand extends $Command<DescribeSchedulingPoliciesCommandInput, DescribeSchedulingPoliciesCommandOutput, BatchClientResolvedConfig> {
43
50
  readonly input: DescribeSchedulingPoliciesCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeSchedulingPoliciesCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeSchedulingPoliciesCommandInput, DescribeSchedulingPoliciesCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { ListJobsRequest, ListJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListJobsCommand}.
8
10
  */
9
11
  export interface ListJobsCommandInput extends ListJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListJobsCommand}.
13
17
  */
14
18
  export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of Batch jobs.</p>
18
23
  * <p>You must specify only one of the following items:</p>
19
24
  * <ul>
@@ -39,6 +44,8 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param ListJobsCommandInput - {@link ListJobsCommandInput}
48
+ * @returns {@link ListJobsCommandOutput}
42
49
  * @see {@link ListJobsCommandInput} for command's `input` shape.
43
50
  * @see {@link ListJobsCommandOutput} for command's `response` shape.
44
51
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -99,11 +106,20 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
99
106
  export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, BatchClientResolvedConfig> {
100
107
  readonly input: ListJobsCommandInput;
101
108
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
102
112
  constructor(input: ListJobsCommandInput);
103
113
  /**
104
114
  * @internal
105
115
  */
106
116
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListJobsCommandInput, ListJobsCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
107
120
  private serialize;
121
+ /**
122
+ * @internal
123
+ */
108
124
  private deserialize;
109
125
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { ListSchedulingPoliciesRequest, ListSchedulingPoliciesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSchedulingPoliciesCommand}.
8
10
  */
9
11
  export interface ListSchedulingPoliciesCommandInput extends ListSchedulingPoliciesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSchedulingPoliciesCommand}.
13
17
  */
14
18
  export interface ListSchedulingPoliciesCommandOutput extends ListSchedulingPoliciesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of Batch scheduling policies.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListSchedulingPoliciesCommandOutput extends ListSchedulingPolic
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListSchedulingPoliciesCommandInput - {@link ListSchedulingPoliciesCommandInput}
34
+ * @returns {@link ListSchedulingPoliciesCommandOutput}
28
35
  * @see {@link ListSchedulingPoliciesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListSchedulingPoliciesCommandOutput} for command's `response` shape.
30
37
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -42,11 +49,20 @@ export interface ListSchedulingPoliciesCommandOutput extends ListSchedulingPolic
42
49
  export declare class ListSchedulingPoliciesCommand extends $Command<ListSchedulingPoliciesCommandInput, ListSchedulingPoliciesCommandOutput, BatchClientResolvedConfig> {
43
50
  readonly input: ListSchedulingPoliciesCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: ListSchedulingPoliciesCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSchedulingPoliciesCommandInput, ListSchedulingPoliciesCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
18
23
  * and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
35
+ * @returns {@link ListTagsForResourceCommandOutput}
29
36
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -63,11 +70,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
63
70
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BatchClientResolvedConfig> {
64
71
  readonly input: ListTagsForResourceCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: ListTagsForResourceCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { RegisterJobDefinitionRequest, RegisterJobDefinitionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RegisterJobDefinitionCommand}.
8
10
  */
9
11
  export interface RegisterJobDefinitionCommandInput extends RegisterJobDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RegisterJobDefinitionCommand}.
13
17
  */
14
18
  export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Registers an Batch job definition.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RegisterJobDefinitionCommandInput - {@link RegisterJobDefinitionCommandInput}
34
+ * @returns {@link RegisterJobDefinitionCommandOutput}
28
35
  * @see {@link RegisterJobDefinitionCommandInput} for command's `input` shape.
29
36
  * @see {@link RegisterJobDefinitionCommandOutput} for command's `response` shape.
30
37
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -118,11 +125,20 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
118
125
  export declare class RegisterJobDefinitionCommand extends $Command<RegisterJobDefinitionCommandInput, RegisterJobDefinitionCommandOutput, BatchClientResolvedConfig> {
119
126
  readonly input: RegisterJobDefinitionCommandInput;
120
127
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
128
+ /**
129
+ * @public
130
+ */
121
131
  constructor(input: RegisterJobDefinitionCommandInput);
122
132
  /**
123
133
  * @internal
124
134
  */
125
135
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterJobDefinitionCommandInput, RegisterJobDefinitionCommandOutput>;
136
+ /**
137
+ * @internal
138
+ */
126
139
  private serialize;
140
+ /**
141
+ * @internal
142
+ */
127
143
  private deserialize;
128
144
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { SubmitJobRequest, SubmitJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SubmitJobCommand}.
8
10
  */
9
11
  export interface SubmitJobCommandInput extends SubmitJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SubmitJobCommand}.
13
17
  */
14
18
  export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Submits an Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a>
18
23
  * override parameters defined in the job definition. vCPU and memory requirements that are specified in the
19
24
  * <code>resourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way
@@ -37,6 +42,8 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param SubmitJobCommandInput - {@link SubmitJobCommandInput}
46
+ * @returns {@link SubmitJobCommandOutput}
40
47
  * @see {@link SubmitJobCommandInput} for command's `input` shape.
41
48
  * @see {@link SubmitJobCommandOutput} for command's `response` shape.
42
49
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -73,11 +80,20 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea
73
80
  export declare class SubmitJobCommand extends $Command<SubmitJobCommandInput, SubmitJobCommandOutput, BatchClientResolvedConfig> {
74
81
  readonly input: SubmitJobCommandInput;
75
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
76
86
  constructor(input: SubmitJobCommandInput);
77
87
  /**
78
88
  * @internal
79
89
  */
80
90
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SubmitJobCommandInput, SubmitJobCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
81
94
  private serialize;
95
+ /**
96
+ * @internal
97
+ */
82
98
  private deserialize;
83
99
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a
18
23
  * resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that
19
24
  * are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
@@ -28,6 +33,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
37
+ * @returns {@link TagResourceCommandOutput}
31
38
  * @see {@link TagResourceCommandInput} for command's `input` shape.
32
39
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -59,11 +66,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
59
66
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BatchClientResolvedConfig> {
60
67
  readonly input: TagResourceCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: TagResourceCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
5
5
  import { TerminateJobRequest, TerminateJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TerminateJobCommand}.
8
10
  */
9
11
  export interface TerminateJobCommandInput extends TerminateJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TerminateJobCommand}.
13
17
  */
14
18
  export interface TerminateJobCommandOutput extends TerminateJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Terminates a job in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are
18
23
  * terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the
19
24
  * <code>STARTING</code> state are cancelled.</p>
@@ -27,6 +32,8 @@ export interface TerminateJobCommandOutput extends TerminateJobResponse, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param TerminateJobCommandInput - {@link TerminateJobCommandInput}
36
+ * @returns {@link TerminateJobCommandOutput}
30
37
  * @see {@link TerminateJobCommandInput} for command's `input` shape.
31
38
  * @see {@link TerminateJobCommandOutput} for command's `response` shape.
32
39
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -56,11 +63,20 @@ export interface TerminateJobCommandOutput extends TerminateJobResponse, __Metad
56
63
  export declare class TerminateJobCommand extends $Command<TerminateJobCommandInput, TerminateJobCommandOutput, BatchClientResolvedConfig> {
57
64
  readonly input: TerminateJobCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: TerminateJobCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TerminateJobCommandInput, TerminateJobCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }