types-boto3-batch 1.36.0__py3-none-any.whl
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.
- types_boto3_batch/__init__.py +51 -0
- types_boto3_batch/__init__.pyi +50 -0
- types_boto3_batch/__main__.py +43 -0
- types_boto3_batch/client.py +432 -0
- types_boto3_batch/client.pyi +429 -0
- types_boto3_batch/literals.py +552 -0
- types_boto3_batch/literals.pyi +550 -0
- types_boto3_batch/paginator.py +172 -0
- types_boto3_batch/paginator.pyi +156 -0
- types_boto3_batch/py.typed +0 -0
- types_boto3_batch/type_defs.py +1574 -0
- types_boto3_batch/type_defs.pyi +1402 -0
- types_boto3_batch/version.py +7 -0
- types_boto3_batch-1.36.0.dist-info/LICENSE +21 -0
- types_boto3_batch-1.36.0.dist-info/METADATA +497 -0
- types_boto3_batch-1.36.0.dist-info/RECORD +18 -0
- types_boto3_batch-1.36.0.dist-info/WHEEL +5 -0
- types_boto3_batch-1.36.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Main interface for batch service.
|
|
3
|
+
|
|
4
|
+
Usage::
|
|
5
|
+
|
|
6
|
+
```python
|
|
7
|
+
from boto3.session import Session
|
|
8
|
+
from types_boto3_batch import (
|
|
9
|
+
BatchClient,
|
|
10
|
+
Client,
|
|
11
|
+
DescribeComputeEnvironmentsPaginator,
|
|
12
|
+
DescribeJobDefinitionsPaginator,
|
|
13
|
+
DescribeJobQueuesPaginator,
|
|
14
|
+
ListJobsPaginator,
|
|
15
|
+
ListSchedulingPoliciesPaginator,
|
|
16
|
+
)
|
|
17
|
+
|
|
18
|
+
session = Session()
|
|
19
|
+
client: BatchClient = session.client("batch")
|
|
20
|
+
|
|
21
|
+
describe_compute_environments_paginator: DescribeComputeEnvironmentsPaginator = client.get_paginator("describe_compute_environments")
|
|
22
|
+
describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get_paginator("describe_job_definitions")
|
|
23
|
+
describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator("describe_job_queues")
|
|
24
|
+
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
|
|
25
|
+
list_scheduling_policies_paginator: ListSchedulingPoliciesPaginator = client.get_paginator("list_scheduling_policies")
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Copyright 2025 Vlad Emelianov
|
|
29
|
+
"""
|
|
30
|
+
|
|
31
|
+
from .client import BatchClient
|
|
32
|
+
from .paginator import (
|
|
33
|
+
DescribeComputeEnvironmentsPaginator,
|
|
34
|
+
DescribeJobDefinitionsPaginator,
|
|
35
|
+
DescribeJobQueuesPaginator,
|
|
36
|
+
ListJobsPaginator,
|
|
37
|
+
ListSchedulingPoliciesPaginator,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
Client = BatchClient
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
__all__ = (
|
|
44
|
+
"BatchClient",
|
|
45
|
+
"Client",
|
|
46
|
+
"DescribeComputeEnvironmentsPaginator",
|
|
47
|
+
"DescribeJobDefinitionsPaginator",
|
|
48
|
+
"DescribeJobQueuesPaginator",
|
|
49
|
+
"ListJobsPaginator",
|
|
50
|
+
"ListSchedulingPoliciesPaginator",
|
|
51
|
+
)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Main interface for batch service.
|
|
3
|
+
|
|
4
|
+
Usage::
|
|
5
|
+
|
|
6
|
+
```python
|
|
7
|
+
from boto3.session import Session
|
|
8
|
+
from types_boto3_batch import (
|
|
9
|
+
BatchClient,
|
|
10
|
+
Client,
|
|
11
|
+
DescribeComputeEnvironmentsPaginator,
|
|
12
|
+
DescribeJobDefinitionsPaginator,
|
|
13
|
+
DescribeJobQueuesPaginator,
|
|
14
|
+
ListJobsPaginator,
|
|
15
|
+
ListSchedulingPoliciesPaginator,
|
|
16
|
+
)
|
|
17
|
+
|
|
18
|
+
session = Session()
|
|
19
|
+
client: BatchClient = session.client("batch")
|
|
20
|
+
|
|
21
|
+
describe_compute_environments_paginator: DescribeComputeEnvironmentsPaginator = client.get_paginator("describe_compute_environments")
|
|
22
|
+
describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get_paginator("describe_job_definitions")
|
|
23
|
+
describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator("describe_job_queues")
|
|
24
|
+
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
|
|
25
|
+
list_scheduling_policies_paginator: ListSchedulingPoliciesPaginator = client.get_paginator("list_scheduling_policies")
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Copyright 2025 Vlad Emelianov
|
|
29
|
+
"""
|
|
30
|
+
|
|
31
|
+
from .client import BatchClient
|
|
32
|
+
from .paginator import (
|
|
33
|
+
DescribeComputeEnvironmentsPaginator,
|
|
34
|
+
DescribeJobDefinitionsPaginator,
|
|
35
|
+
DescribeJobQueuesPaginator,
|
|
36
|
+
ListJobsPaginator,
|
|
37
|
+
ListSchedulingPoliciesPaginator,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
Client = BatchClient
|
|
41
|
+
|
|
42
|
+
__all__ = (
|
|
43
|
+
"BatchClient",
|
|
44
|
+
"Client",
|
|
45
|
+
"DescribeComputeEnvironmentsPaginator",
|
|
46
|
+
"DescribeJobDefinitionsPaginator",
|
|
47
|
+
"DescribeJobQueuesPaginator",
|
|
48
|
+
"ListJobsPaginator",
|
|
49
|
+
"ListSchedulingPoliciesPaginator",
|
|
50
|
+
)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Main CLI entrypoint.
|
|
3
|
+
|
|
4
|
+
Copyright 2025 Vlad Emelianov
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
import sys
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def print_info() -> None:
|
|
11
|
+
"""
|
|
12
|
+
Print package info to stdout.
|
|
13
|
+
"""
|
|
14
|
+
sys.stdout.write(
|
|
15
|
+
"Type annotations for boto3 Batch 1.36.0\n"
|
|
16
|
+
"Version: 1.36.0\n"
|
|
17
|
+
"Builder version: 8.8.0\n"
|
|
18
|
+
"Docs: https://youtype.github.io/types_boto3_docs/types_boto3_batch//\n"
|
|
19
|
+
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch.html#batch\n"
|
|
20
|
+
"Other services: https://pypi.org/project/boto3-stubs/\n"
|
|
21
|
+
"Changelog: https://github.com/youtype/mypy_boto3_builder/releases\n"
|
|
22
|
+
)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def print_version() -> None:
|
|
26
|
+
"""
|
|
27
|
+
Print package version to stdout.
|
|
28
|
+
"""
|
|
29
|
+
sys.stdout.write("1.36.0\n")
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def main() -> None:
|
|
33
|
+
"""
|
|
34
|
+
Main CLI entrypoint.
|
|
35
|
+
"""
|
|
36
|
+
if "--version" in sys.argv:
|
|
37
|
+
print_version()
|
|
38
|
+
return
|
|
39
|
+
print_info()
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
if __name__ == "__main__":
|
|
43
|
+
main()
|
|
@@ -0,0 +1,432 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Type annotations for batch service Client.
|
|
3
|
+
|
|
4
|
+
[Documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/)
|
|
5
|
+
|
|
6
|
+
Usage::
|
|
7
|
+
|
|
8
|
+
```python
|
|
9
|
+
from boto3.session import Session
|
|
10
|
+
from types_boto3_batch.client import BatchClient
|
|
11
|
+
|
|
12
|
+
session = Session()
|
|
13
|
+
client: BatchClient = session.client("batch")
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Copyright 2025 Vlad Emelianov
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
from __future__ import annotations
|
|
20
|
+
|
|
21
|
+
import sys
|
|
22
|
+
from typing import Any, overload
|
|
23
|
+
|
|
24
|
+
from botocore.client import BaseClient, ClientMeta
|
|
25
|
+
from botocore.errorfactory import BaseClientExceptions
|
|
26
|
+
from botocore.exceptions import ClientError as BotocoreClientError
|
|
27
|
+
|
|
28
|
+
from .paginator import (
|
|
29
|
+
DescribeComputeEnvironmentsPaginator,
|
|
30
|
+
DescribeJobDefinitionsPaginator,
|
|
31
|
+
DescribeJobQueuesPaginator,
|
|
32
|
+
ListJobsPaginator,
|
|
33
|
+
ListSchedulingPoliciesPaginator,
|
|
34
|
+
)
|
|
35
|
+
from .type_defs import (
|
|
36
|
+
CancelJobRequestRequestTypeDef,
|
|
37
|
+
CreateComputeEnvironmentRequestRequestTypeDef,
|
|
38
|
+
CreateComputeEnvironmentResponseTypeDef,
|
|
39
|
+
CreateJobQueueRequestRequestTypeDef,
|
|
40
|
+
CreateJobQueueResponseTypeDef,
|
|
41
|
+
CreateSchedulingPolicyRequestRequestTypeDef,
|
|
42
|
+
CreateSchedulingPolicyResponseTypeDef,
|
|
43
|
+
DeleteComputeEnvironmentRequestRequestTypeDef,
|
|
44
|
+
DeleteJobQueueRequestRequestTypeDef,
|
|
45
|
+
DeleteSchedulingPolicyRequestRequestTypeDef,
|
|
46
|
+
DeregisterJobDefinitionRequestRequestTypeDef,
|
|
47
|
+
DescribeComputeEnvironmentsRequestRequestTypeDef,
|
|
48
|
+
DescribeComputeEnvironmentsResponseTypeDef,
|
|
49
|
+
DescribeJobDefinitionsRequestRequestTypeDef,
|
|
50
|
+
DescribeJobDefinitionsResponseTypeDef,
|
|
51
|
+
DescribeJobQueuesRequestRequestTypeDef,
|
|
52
|
+
DescribeJobQueuesResponseTypeDef,
|
|
53
|
+
DescribeJobsRequestRequestTypeDef,
|
|
54
|
+
DescribeJobsResponseTypeDef,
|
|
55
|
+
DescribeSchedulingPoliciesRequestRequestTypeDef,
|
|
56
|
+
DescribeSchedulingPoliciesResponseTypeDef,
|
|
57
|
+
GetJobQueueSnapshotRequestRequestTypeDef,
|
|
58
|
+
GetJobQueueSnapshotResponseTypeDef,
|
|
59
|
+
ListJobsRequestRequestTypeDef,
|
|
60
|
+
ListJobsResponseTypeDef,
|
|
61
|
+
ListSchedulingPoliciesRequestRequestTypeDef,
|
|
62
|
+
ListSchedulingPoliciesResponseTypeDef,
|
|
63
|
+
ListTagsForResourceRequestRequestTypeDef,
|
|
64
|
+
ListTagsForResourceResponseTypeDef,
|
|
65
|
+
RegisterJobDefinitionRequestRequestTypeDef,
|
|
66
|
+
RegisterJobDefinitionResponseTypeDef,
|
|
67
|
+
SubmitJobRequestRequestTypeDef,
|
|
68
|
+
SubmitJobResponseTypeDef,
|
|
69
|
+
TagResourceRequestRequestTypeDef,
|
|
70
|
+
TerminateJobRequestRequestTypeDef,
|
|
71
|
+
UntagResourceRequestRequestTypeDef,
|
|
72
|
+
UpdateComputeEnvironmentRequestRequestTypeDef,
|
|
73
|
+
UpdateComputeEnvironmentResponseTypeDef,
|
|
74
|
+
UpdateJobQueueRequestRequestTypeDef,
|
|
75
|
+
UpdateJobQueueResponseTypeDef,
|
|
76
|
+
UpdateSchedulingPolicyRequestRequestTypeDef,
|
|
77
|
+
)
|
|
78
|
+
|
|
79
|
+
if sys.version_info >= (3, 9):
|
|
80
|
+
from builtins import dict as Dict
|
|
81
|
+
from builtins import type as Type
|
|
82
|
+
from collections.abc import Mapping
|
|
83
|
+
else:
|
|
84
|
+
from typing import Dict, Mapping, Type
|
|
85
|
+
if sys.version_info >= (3, 12):
|
|
86
|
+
from typing import Literal, Unpack
|
|
87
|
+
else:
|
|
88
|
+
from typing_extensions import Literal, Unpack
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
__all__ = ("BatchClient",)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
class Exceptions(BaseClientExceptions):
|
|
95
|
+
ClientError: Type[BotocoreClientError]
|
|
96
|
+
ClientException: Type[BotocoreClientError]
|
|
97
|
+
ServerException: Type[BotocoreClientError]
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
class BatchClient(BaseClient):
|
|
101
|
+
"""
|
|
102
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch.html#Batch.Client)
|
|
103
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/)
|
|
104
|
+
"""
|
|
105
|
+
|
|
106
|
+
meta: ClientMeta
|
|
107
|
+
|
|
108
|
+
@property
|
|
109
|
+
def exceptions(self) -> Exceptions:
|
|
110
|
+
"""
|
|
111
|
+
BatchClient exceptions.
|
|
112
|
+
|
|
113
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch.html#Batch.Client)
|
|
114
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#exceptions)
|
|
115
|
+
"""
|
|
116
|
+
|
|
117
|
+
def can_paginate(self, operation_name: str) -> bool:
|
|
118
|
+
"""
|
|
119
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/can_paginate.html)
|
|
120
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#can_paginate)
|
|
121
|
+
"""
|
|
122
|
+
|
|
123
|
+
def generate_presigned_url(
|
|
124
|
+
self,
|
|
125
|
+
ClientMethod: str,
|
|
126
|
+
Params: Mapping[str, Any] = ...,
|
|
127
|
+
ExpiresIn: int = 3600,
|
|
128
|
+
HttpMethod: str = ...,
|
|
129
|
+
) -> str:
|
|
130
|
+
"""
|
|
131
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/generate_presigned_url.html)
|
|
132
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#generate_presigned_url)
|
|
133
|
+
"""
|
|
134
|
+
|
|
135
|
+
def cancel_job(self, **kwargs: Unpack[CancelJobRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
136
|
+
"""
|
|
137
|
+
Cancels a job in an Batch job queue.
|
|
138
|
+
|
|
139
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/cancel_job.html)
|
|
140
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#cancel_job)
|
|
141
|
+
"""
|
|
142
|
+
|
|
143
|
+
def create_compute_environment(
|
|
144
|
+
self, **kwargs: Unpack[CreateComputeEnvironmentRequestRequestTypeDef]
|
|
145
|
+
) -> CreateComputeEnvironmentResponseTypeDef:
|
|
146
|
+
"""
|
|
147
|
+
Creates an Batch compute environment.
|
|
148
|
+
|
|
149
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/create_compute_environment.html)
|
|
150
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#create_compute_environment)
|
|
151
|
+
"""
|
|
152
|
+
|
|
153
|
+
def create_job_queue(
|
|
154
|
+
self, **kwargs: Unpack[CreateJobQueueRequestRequestTypeDef]
|
|
155
|
+
) -> CreateJobQueueResponseTypeDef:
|
|
156
|
+
"""
|
|
157
|
+
Creates an Batch job queue.
|
|
158
|
+
|
|
159
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/create_job_queue.html)
|
|
160
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#create_job_queue)
|
|
161
|
+
"""
|
|
162
|
+
|
|
163
|
+
def create_scheduling_policy(
|
|
164
|
+
self, **kwargs: Unpack[CreateSchedulingPolicyRequestRequestTypeDef]
|
|
165
|
+
) -> CreateSchedulingPolicyResponseTypeDef:
|
|
166
|
+
"""
|
|
167
|
+
Creates an Batch scheduling policy.
|
|
168
|
+
|
|
169
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/create_scheduling_policy.html)
|
|
170
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#create_scheduling_policy)
|
|
171
|
+
"""
|
|
172
|
+
|
|
173
|
+
def delete_compute_environment(
|
|
174
|
+
self, **kwargs: Unpack[DeleteComputeEnvironmentRequestRequestTypeDef]
|
|
175
|
+
) -> Dict[str, Any]:
|
|
176
|
+
"""
|
|
177
|
+
Deletes an Batch compute environment.
|
|
178
|
+
|
|
179
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/delete_compute_environment.html)
|
|
180
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#delete_compute_environment)
|
|
181
|
+
"""
|
|
182
|
+
|
|
183
|
+
def delete_job_queue(
|
|
184
|
+
self, **kwargs: Unpack[DeleteJobQueueRequestRequestTypeDef]
|
|
185
|
+
) -> Dict[str, Any]:
|
|
186
|
+
"""
|
|
187
|
+
Deletes the specified job queue.
|
|
188
|
+
|
|
189
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/delete_job_queue.html)
|
|
190
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#delete_job_queue)
|
|
191
|
+
"""
|
|
192
|
+
|
|
193
|
+
def delete_scheduling_policy(
|
|
194
|
+
self, **kwargs: Unpack[DeleteSchedulingPolicyRequestRequestTypeDef]
|
|
195
|
+
) -> Dict[str, Any]:
|
|
196
|
+
"""
|
|
197
|
+
Deletes the specified scheduling policy.
|
|
198
|
+
|
|
199
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/delete_scheduling_policy.html)
|
|
200
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#delete_scheduling_policy)
|
|
201
|
+
"""
|
|
202
|
+
|
|
203
|
+
def deregister_job_definition(
|
|
204
|
+
self, **kwargs: Unpack[DeregisterJobDefinitionRequestRequestTypeDef]
|
|
205
|
+
) -> Dict[str, Any]:
|
|
206
|
+
"""
|
|
207
|
+
Deregisters an Batch job definition.
|
|
208
|
+
|
|
209
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/deregister_job_definition.html)
|
|
210
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#deregister_job_definition)
|
|
211
|
+
"""
|
|
212
|
+
|
|
213
|
+
def describe_compute_environments(
|
|
214
|
+
self, **kwargs: Unpack[DescribeComputeEnvironmentsRequestRequestTypeDef]
|
|
215
|
+
) -> DescribeComputeEnvironmentsResponseTypeDef:
|
|
216
|
+
"""
|
|
217
|
+
Describes one or more of your compute environments.
|
|
218
|
+
|
|
219
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/describe_compute_environments.html)
|
|
220
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#describe_compute_environments)
|
|
221
|
+
"""
|
|
222
|
+
|
|
223
|
+
def describe_job_definitions(
|
|
224
|
+
self, **kwargs: Unpack[DescribeJobDefinitionsRequestRequestTypeDef]
|
|
225
|
+
) -> DescribeJobDefinitionsResponseTypeDef:
|
|
226
|
+
"""
|
|
227
|
+
Describes a list of job definitions.
|
|
228
|
+
|
|
229
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/describe_job_definitions.html)
|
|
230
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#describe_job_definitions)
|
|
231
|
+
"""
|
|
232
|
+
|
|
233
|
+
def describe_job_queues(
|
|
234
|
+
self, **kwargs: Unpack[DescribeJobQueuesRequestRequestTypeDef]
|
|
235
|
+
) -> DescribeJobQueuesResponseTypeDef:
|
|
236
|
+
"""
|
|
237
|
+
Describes one or more of your job queues.
|
|
238
|
+
|
|
239
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/describe_job_queues.html)
|
|
240
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#describe_job_queues)
|
|
241
|
+
"""
|
|
242
|
+
|
|
243
|
+
def describe_jobs(
|
|
244
|
+
self, **kwargs: Unpack[DescribeJobsRequestRequestTypeDef]
|
|
245
|
+
) -> DescribeJobsResponseTypeDef:
|
|
246
|
+
"""
|
|
247
|
+
Describes a list of Batch jobs.
|
|
248
|
+
|
|
249
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/describe_jobs.html)
|
|
250
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#describe_jobs)
|
|
251
|
+
"""
|
|
252
|
+
|
|
253
|
+
def describe_scheduling_policies(
|
|
254
|
+
self, **kwargs: Unpack[DescribeSchedulingPoliciesRequestRequestTypeDef]
|
|
255
|
+
) -> DescribeSchedulingPoliciesResponseTypeDef:
|
|
256
|
+
"""
|
|
257
|
+
Describes one or more of your scheduling policies.
|
|
258
|
+
|
|
259
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/describe_scheduling_policies.html)
|
|
260
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#describe_scheduling_policies)
|
|
261
|
+
"""
|
|
262
|
+
|
|
263
|
+
def get_job_queue_snapshot(
|
|
264
|
+
self, **kwargs: Unpack[GetJobQueueSnapshotRequestRequestTypeDef]
|
|
265
|
+
) -> GetJobQueueSnapshotResponseTypeDef:
|
|
266
|
+
"""
|
|
267
|
+
Provides a list of the first 100 <code>RUNNABLE</code> jobs associated to a
|
|
268
|
+
single job queue.
|
|
269
|
+
|
|
270
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/get_job_queue_snapshot.html)
|
|
271
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#get_job_queue_snapshot)
|
|
272
|
+
"""
|
|
273
|
+
|
|
274
|
+
def list_jobs(self, **kwargs: Unpack[ListJobsRequestRequestTypeDef]) -> ListJobsResponseTypeDef:
|
|
275
|
+
"""
|
|
276
|
+
Returns a list of Batch jobs.
|
|
277
|
+
|
|
278
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/list_jobs.html)
|
|
279
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#list_jobs)
|
|
280
|
+
"""
|
|
281
|
+
|
|
282
|
+
def list_scheduling_policies(
|
|
283
|
+
self, **kwargs: Unpack[ListSchedulingPoliciesRequestRequestTypeDef]
|
|
284
|
+
) -> ListSchedulingPoliciesResponseTypeDef:
|
|
285
|
+
"""
|
|
286
|
+
Returns a list of Batch scheduling policies.
|
|
287
|
+
|
|
288
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/list_scheduling_policies.html)
|
|
289
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#list_scheduling_policies)
|
|
290
|
+
"""
|
|
291
|
+
|
|
292
|
+
def list_tags_for_resource(
|
|
293
|
+
self, **kwargs: Unpack[ListTagsForResourceRequestRequestTypeDef]
|
|
294
|
+
) -> ListTagsForResourceResponseTypeDef:
|
|
295
|
+
"""
|
|
296
|
+
Lists the tags for an Batch resource.
|
|
297
|
+
|
|
298
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/list_tags_for_resource.html)
|
|
299
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#list_tags_for_resource)
|
|
300
|
+
"""
|
|
301
|
+
|
|
302
|
+
def register_job_definition(
|
|
303
|
+
self, **kwargs: Unpack[RegisterJobDefinitionRequestRequestTypeDef]
|
|
304
|
+
) -> RegisterJobDefinitionResponseTypeDef:
|
|
305
|
+
"""
|
|
306
|
+
Registers an Batch job definition.
|
|
307
|
+
|
|
308
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/register_job_definition.html)
|
|
309
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#register_job_definition)
|
|
310
|
+
"""
|
|
311
|
+
|
|
312
|
+
def submit_job(
|
|
313
|
+
self, **kwargs: Unpack[SubmitJobRequestRequestTypeDef]
|
|
314
|
+
) -> SubmitJobResponseTypeDef:
|
|
315
|
+
"""
|
|
316
|
+
Submits an Batch job from a job definition.
|
|
317
|
+
|
|
318
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/submit_job.html)
|
|
319
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#submit_job)
|
|
320
|
+
"""
|
|
321
|
+
|
|
322
|
+
def tag_resource(self, **kwargs: Unpack[TagResourceRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
323
|
+
"""
|
|
324
|
+
Associates the specified tags to a resource with the specified
|
|
325
|
+
<code>resourceArn</code>.
|
|
326
|
+
|
|
327
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/tag_resource.html)
|
|
328
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#tag_resource)
|
|
329
|
+
"""
|
|
330
|
+
|
|
331
|
+
def terminate_job(self, **kwargs: Unpack[TerminateJobRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
332
|
+
"""
|
|
333
|
+
Terminates a job in a job queue.
|
|
334
|
+
|
|
335
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/terminate_job.html)
|
|
336
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#terminate_job)
|
|
337
|
+
"""
|
|
338
|
+
|
|
339
|
+
def untag_resource(
|
|
340
|
+
self, **kwargs: Unpack[UntagResourceRequestRequestTypeDef]
|
|
341
|
+
) -> Dict[str, Any]:
|
|
342
|
+
"""
|
|
343
|
+
Deletes specified tags from an Batch resource.
|
|
344
|
+
|
|
345
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/untag_resource.html)
|
|
346
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#untag_resource)
|
|
347
|
+
"""
|
|
348
|
+
|
|
349
|
+
def update_compute_environment(
|
|
350
|
+
self, **kwargs: Unpack[UpdateComputeEnvironmentRequestRequestTypeDef]
|
|
351
|
+
) -> UpdateComputeEnvironmentResponseTypeDef:
|
|
352
|
+
"""
|
|
353
|
+
Updates an Batch compute environment.
|
|
354
|
+
|
|
355
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/update_compute_environment.html)
|
|
356
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#update_compute_environment)
|
|
357
|
+
"""
|
|
358
|
+
|
|
359
|
+
def update_job_queue(
|
|
360
|
+
self, **kwargs: Unpack[UpdateJobQueueRequestRequestTypeDef]
|
|
361
|
+
) -> UpdateJobQueueResponseTypeDef:
|
|
362
|
+
"""
|
|
363
|
+
Updates a job queue.
|
|
364
|
+
|
|
365
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/update_job_queue.html)
|
|
366
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#update_job_queue)
|
|
367
|
+
"""
|
|
368
|
+
|
|
369
|
+
def update_scheduling_policy(
|
|
370
|
+
self, **kwargs: Unpack[UpdateSchedulingPolicyRequestRequestTypeDef]
|
|
371
|
+
) -> Dict[str, Any]:
|
|
372
|
+
"""
|
|
373
|
+
Updates a scheduling policy.
|
|
374
|
+
|
|
375
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/update_scheduling_policy.html)
|
|
376
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#update_scheduling_policy)
|
|
377
|
+
"""
|
|
378
|
+
|
|
379
|
+
@overload # type: ignore[override]
|
|
380
|
+
def get_paginator( # type: ignore[override]
|
|
381
|
+
self, operation_name: Literal["describe_compute_environments"]
|
|
382
|
+
) -> DescribeComputeEnvironmentsPaginator:
|
|
383
|
+
"""
|
|
384
|
+
Create a paginator for an operation.
|
|
385
|
+
|
|
386
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/get_paginator.html)
|
|
387
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#get_paginator)
|
|
388
|
+
"""
|
|
389
|
+
|
|
390
|
+
@overload # type: ignore[override]
|
|
391
|
+
def get_paginator( # type: ignore[override]
|
|
392
|
+
self, operation_name: Literal["describe_job_definitions"]
|
|
393
|
+
) -> DescribeJobDefinitionsPaginator:
|
|
394
|
+
"""
|
|
395
|
+
Create a paginator for an operation.
|
|
396
|
+
|
|
397
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/get_paginator.html)
|
|
398
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#get_paginator)
|
|
399
|
+
"""
|
|
400
|
+
|
|
401
|
+
@overload # type: ignore[override]
|
|
402
|
+
def get_paginator( # type: ignore[override]
|
|
403
|
+
self, operation_name: Literal["describe_job_queues"]
|
|
404
|
+
) -> DescribeJobQueuesPaginator:
|
|
405
|
+
"""
|
|
406
|
+
Create a paginator for an operation.
|
|
407
|
+
|
|
408
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/get_paginator.html)
|
|
409
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#get_paginator)
|
|
410
|
+
"""
|
|
411
|
+
|
|
412
|
+
@overload # type: ignore[override]
|
|
413
|
+
def get_paginator( # type: ignore[override]
|
|
414
|
+
self, operation_name: Literal["list_jobs"]
|
|
415
|
+
) -> ListJobsPaginator:
|
|
416
|
+
"""
|
|
417
|
+
Create a paginator for an operation.
|
|
418
|
+
|
|
419
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/get_paginator.html)
|
|
420
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#get_paginator)
|
|
421
|
+
"""
|
|
422
|
+
|
|
423
|
+
@overload # type: ignore[override]
|
|
424
|
+
def get_paginator( # type: ignore[override]
|
|
425
|
+
self, operation_name: Literal["list_scheduling_policies"]
|
|
426
|
+
) -> ListSchedulingPoliciesPaginator:
|
|
427
|
+
"""
|
|
428
|
+
Create a paginator for an operation.
|
|
429
|
+
|
|
430
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch/client/get_paginator.html)
|
|
431
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_batch/client/#get_paginator)
|
|
432
|
+
"""
|