types-boto3-connectcases 1.35.71__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_connectcases/__init__.py +31 -0
- types_boto3_connectcases/__init__.pyi +30 -0
- types_boto3_connectcases/__main__.py +42 -0
- types_boto3_connectcases/client.py +508 -0
- types_boto3_connectcases/client.pyi +504 -0
- types_boto3_connectcases/literals.py +477 -0
- types_boto3_connectcases/literals.pyi +475 -0
- types_boto3_connectcases/paginator.py +85 -0
- types_boto3_connectcases/paginator.pyi +78 -0
- types_boto3_connectcases/py.typed +0 -0
- types_boto3_connectcases/type_defs.py +935 -0
- types_boto3_connectcases/type_defs.pyi +819 -0
- types_boto3_connectcases/version.py +7 -0
- types_boto3_connectcases-1.35.71.dist-info/LICENSE +21 -0
- types_boto3_connectcases-1.35.71.dist-info/METADATA +432 -0
- types_boto3_connectcases-1.35.71.dist-info/RECORD +18 -0
- types_boto3_connectcases-1.35.71.dist-info/WHEEL +5 -0
- types_boto3_connectcases-1.35.71.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Main interface for connectcases service.
|
|
3
|
+
|
|
4
|
+
Usage::
|
|
5
|
+
|
|
6
|
+
```python
|
|
7
|
+
from boto3.session import Session
|
|
8
|
+
from types_boto3_connectcases import (
|
|
9
|
+
Client,
|
|
10
|
+
ConnectCasesClient,
|
|
11
|
+
SearchCasesPaginator,
|
|
12
|
+
SearchRelatedItemsPaginator,
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
session = Session()
|
|
16
|
+
client: ConnectCasesClient = session.client("connectcases")
|
|
17
|
+
|
|
18
|
+
search_cases_paginator: SearchCasesPaginator = client.get_paginator("search_cases")
|
|
19
|
+
search_related_items_paginator: SearchRelatedItemsPaginator = client.get_paginator("search_related_items")
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Copyright 2024 Vlad Emelianov
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
from .client import ConnectCasesClient
|
|
26
|
+
from .paginator import SearchCasesPaginator, SearchRelatedItemsPaginator
|
|
27
|
+
|
|
28
|
+
Client = ConnectCasesClient
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
__all__ = ("Client", "ConnectCasesClient", "SearchCasesPaginator", "SearchRelatedItemsPaginator")
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Main interface for connectcases service.
|
|
3
|
+
|
|
4
|
+
Usage::
|
|
5
|
+
|
|
6
|
+
```python
|
|
7
|
+
from boto3.session import Session
|
|
8
|
+
from types_boto3_connectcases import (
|
|
9
|
+
Client,
|
|
10
|
+
ConnectCasesClient,
|
|
11
|
+
SearchCasesPaginator,
|
|
12
|
+
SearchRelatedItemsPaginator,
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
session = Session()
|
|
16
|
+
client: ConnectCasesClient = session.client("connectcases")
|
|
17
|
+
|
|
18
|
+
search_cases_paginator: SearchCasesPaginator = client.get_paginator("search_cases")
|
|
19
|
+
search_related_items_paginator: SearchRelatedItemsPaginator = client.get_paginator("search_related_items")
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Copyright 2024 Vlad Emelianov
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
from .client import ConnectCasesClient
|
|
26
|
+
from .paginator import SearchCasesPaginator, SearchRelatedItemsPaginator
|
|
27
|
+
|
|
28
|
+
Client = ConnectCasesClient
|
|
29
|
+
|
|
30
|
+
__all__ = ("Client", "ConnectCasesClient", "SearchCasesPaginator", "SearchRelatedItemsPaginator")
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Main CLI entrypoint.
|
|
3
|
+
|
|
4
|
+
Copyright 2024 Vlad Emelianov
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
import sys
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def print_info() -> None:
|
|
11
|
+
"""
|
|
12
|
+
Print package info to stdout.
|
|
13
|
+
"""
|
|
14
|
+
print(
|
|
15
|
+
"Type annotations for boto3 ConnectCases 1.35.71\n"
|
|
16
|
+
"Version: 1.35.71\n"
|
|
17
|
+
"Builder version: 8.4.1\n"
|
|
18
|
+
"Docs: https://youtype.github.io/types_boto3_docs/types_boto3_connectcases//\n"
|
|
19
|
+
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases.html#connectcases\n"
|
|
20
|
+
"Other services: https://pypi.org/project/boto3-stubs/\n"
|
|
21
|
+
"Changelog: https://github.com/youtype/mypy_boto3_builder/releases"
|
|
22
|
+
)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def print_version() -> None:
|
|
26
|
+
"""
|
|
27
|
+
Print package version to stdout.
|
|
28
|
+
"""
|
|
29
|
+
print("1.35.71")
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def main() -> None:
|
|
33
|
+
"""
|
|
34
|
+
Main CLI entrypoint.
|
|
35
|
+
"""
|
|
36
|
+
if "--version" in sys.argv:
|
|
37
|
+
return print_version()
|
|
38
|
+
print_info()
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
if __name__ == "__main__":
|
|
42
|
+
main()
|
|
@@ -0,0 +1,508 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Type annotations for connectcases service client.
|
|
3
|
+
|
|
4
|
+
[Open documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/)
|
|
5
|
+
|
|
6
|
+
Usage::
|
|
7
|
+
|
|
8
|
+
```python
|
|
9
|
+
from boto3.session import Session
|
|
10
|
+
from types_boto3_connectcases.client import ConnectCasesClient
|
|
11
|
+
|
|
12
|
+
session = Session()
|
|
13
|
+
client: ConnectCasesClient = session.client("connectcases")
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Copyright 2024 Vlad Emelianov
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
import sys
|
|
20
|
+
from typing import Any, Dict, Mapping, Type, overload
|
|
21
|
+
|
|
22
|
+
from botocore.client import BaseClient, ClientMeta
|
|
23
|
+
|
|
24
|
+
from .paginator import SearchCasesPaginator, SearchRelatedItemsPaginator
|
|
25
|
+
from .type_defs import (
|
|
26
|
+
BatchGetFieldRequestRequestTypeDef,
|
|
27
|
+
BatchGetFieldResponseTypeDef,
|
|
28
|
+
BatchPutFieldOptionsRequestRequestTypeDef,
|
|
29
|
+
BatchPutFieldOptionsResponseTypeDef,
|
|
30
|
+
CreateCaseRequestRequestTypeDef,
|
|
31
|
+
CreateCaseResponseTypeDef,
|
|
32
|
+
CreateDomainRequestRequestTypeDef,
|
|
33
|
+
CreateDomainResponseTypeDef,
|
|
34
|
+
CreateFieldRequestRequestTypeDef,
|
|
35
|
+
CreateFieldResponseTypeDef,
|
|
36
|
+
CreateLayoutRequestRequestTypeDef,
|
|
37
|
+
CreateLayoutResponseTypeDef,
|
|
38
|
+
CreateRelatedItemRequestRequestTypeDef,
|
|
39
|
+
CreateRelatedItemResponseTypeDef,
|
|
40
|
+
CreateTemplateRequestRequestTypeDef,
|
|
41
|
+
CreateTemplateResponseTypeDef,
|
|
42
|
+
DeleteDomainRequestRequestTypeDef,
|
|
43
|
+
DeleteFieldRequestRequestTypeDef,
|
|
44
|
+
DeleteLayoutRequestRequestTypeDef,
|
|
45
|
+
DeleteTemplateRequestRequestTypeDef,
|
|
46
|
+
EmptyResponseMetadataTypeDef,
|
|
47
|
+
GetCaseAuditEventsRequestRequestTypeDef,
|
|
48
|
+
GetCaseAuditEventsResponseTypeDef,
|
|
49
|
+
GetCaseEventConfigurationRequestRequestTypeDef,
|
|
50
|
+
GetCaseEventConfigurationResponseTypeDef,
|
|
51
|
+
GetCaseRequestRequestTypeDef,
|
|
52
|
+
GetCaseResponseTypeDef,
|
|
53
|
+
GetDomainRequestRequestTypeDef,
|
|
54
|
+
GetDomainResponseTypeDef,
|
|
55
|
+
GetLayoutRequestRequestTypeDef,
|
|
56
|
+
GetLayoutResponseTypeDef,
|
|
57
|
+
GetTemplateRequestRequestTypeDef,
|
|
58
|
+
GetTemplateResponseTypeDef,
|
|
59
|
+
ListCasesForContactRequestRequestTypeDef,
|
|
60
|
+
ListCasesForContactResponseTypeDef,
|
|
61
|
+
ListDomainsRequestRequestTypeDef,
|
|
62
|
+
ListDomainsResponseTypeDef,
|
|
63
|
+
ListFieldOptionsRequestRequestTypeDef,
|
|
64
|
+
ListFieldOptionsResponseTypeDef,
|
|
65
|
+
ListFieldsRequestRequestTypeDef,
|
|
66
|
+
ListFieldsResponseTypeDef,
|
|
67
|
+
ListLayoutsRequestRequestTypeDef,
|
|
68
|
+
ListLayoutsResponseTypeDef,
|
|
69
|
+
ListTagsForResourceRequestRequestTypeDef,
|
|
70
|
+
ListTagsForResourceResponseTypeDef,
|
|
71
|
+
ListTemplatesRequestRequestTypeDef,
|
|
72
|
+
ListTemplatesResponseTypeDef,
|
|
73
|
+
PutCaseEventConfigurationRequestRequestTypeDef,
|
|
74
|
+
SearchCasesRequestRequestTypeDef,
|
|
75
|
+
SearchCasesResponseTypeDef,
|
|
76
|
+
SearchRelatedItemsRequestRequestTypeDef,
|
|
77
|
+
SearchRelatedItemsResponseTypeDef,
|
|
78
|
+
TagResourceRequestRequestTypeDef,
|
|
79
|
+
UntagResourceRequestRequestTypeDef,
|
|
80
|
+
UpdateCaseRequestRequestTypeDef,
|
|
81
|
+
UpdateFieldRequestRequestTypeDef,
|
|
82
|
+
UpdateLayoutRequestRequestTypeDef,
|
|
83
|
+
UpdateTemplateRequestRequestTypeDef,
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
if sys.version_info >= (3, 12):
|
|
87
|
+
from typing import Literal, Unpack
|
|
88
|
+
else:
|
|
89
|
+
from typing_extensions import Literal, Unpack
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
__all__ = ("ConnectCasesClient",)
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
class BotocoreClientError(Exception):
|
|
96
|
+
MSG_TEMPLATE: str
|
|
97
|
+
|
|
98
|
+
def __init__(self, error_response: Mapping[str, Any], operation_name: str) -> None:
|
|
99
|
+
self.response: Dict[str, Any]
|
|
100
|
+
self.operation_name: str
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
class Exceptions:
|
|
104
|
+
AccessDeniedException: Type[BotocoreClientError]
|
|
105
|
+
ClientError: Type[BotocoreClientError]
|
|
106
|
+
ConflictException: Type[BotocoreClientError]
|
|
107
|
+
InternalServerException: Type[BotocoreClientError]
|
|
108
|
+
ResourceNotFoundException: Type[BotocoreClientError]
|
|
109
|
+
ServiceQuotaExceededException: Type[BotocoreClientError]
|
|
110
|
+
ThrottlingException: Type[BotocoreClientError]
|
|
111
|
+
ValidationException: Type[BotocoreClientError]
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
class ConnectCasesClient(BaseClient):
|
|
115
|
+
"""
|
|
116
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases.html#ConnectCases.Client)
|
|
117
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/)
|
|
118
|
+
"""
|
|
119
|
+
|
|
120
|
+
meta: ClientMeta
|
|
121
|
+
|
|
122
|
+
@property
|
|
123
|
+
def exceptions(self) -> Exceptions:
|
|
124
|
+
"""
|
|
125
|
+
ConnectCasesClient exceptions.
|
|
126
|
+
|
|
127
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases.html#ConnectCases.Client)
|
|
128
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#exceptions)
|
|
129
|
+
"""
|
|
130
|
+
|
|
131
|
+
def can_paginate(self, operation_name: str) -> bool:
|
|
132
|
+
"""
|
|
133
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/can_paginate.html)
|
|
134
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#can_paginate)
|
|
135
|
+
"""
|
|
136
|
+
|
|
137
|
+
def generate_presigned_url(
|
|
138
|
+
self,
|
|
139
|
+
ClientMethod: str,
|
|
140
|
+
Params: Mapping[str, Any] = ...,
|
|
141
|
+
ExpiresIn: int = 3600,
|
|
142
|
+
HttpMethod: str = ...,
|
|
143
|
+
) -> str:
|
|
144
|
+
"""
|
|
145
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/generate_presigned_url.html)
|
|
146
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#generate_presigned_url)
|
|
147
|
+
"""
|
|
148
|
+
|
|
149
|
+
def close(self) -> None:
|
|
150
|
+
"""
|
|
151
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/close.html)
|
|
152
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#close)
|
|
153
|
+
"""
|
|
154
|
+
|
|
155
|
+
def batch_get_field(
|
|
156
|
+
self, **kwargs: Unpack[BatchGetFieldRequestRequestTypeDef]
|
|
157
|
+
) -> BatchGetFieldResponseTypeDef:
|
|
158
|
+
"""
|
|
159
|
+
Returns the description for the list of fields in the request parameters.
|
|
160
|
+
|
|
161
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/batch_get_field.html)
|
|
162
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#batch_get_field)
|
|
163
|
+
"""
|
|
164
|
+
|
|
165
|
+
def batch_put_field_options(
|
|
166
|
+
self, **kwargs: Unpack[BatchPutFieldOptionsRequestRequestTypeDef]
|
|
167
|
+
) -> BatchPutFieldOptionsResponseTypeDef:
|
|
168
|
+
"""
|
|
169
|
+
Creates and updates a set of field options for a single select field in a Cases
|
|
170
|
+
domain.
|
|
171
|
+
|
|
172
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/batch_put_field_options.html)
|
|
173
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#batch_put_field_options)
|
|
174
|
+
"""
|
|
175
|
+
|
|
176
|
+
def create_case(
|
|
177
|
+
self, **kwargs: Unpack[CreateCaseRequestRequestTypeDef]
|
|
178
|
+
) -> CreateCaseResponseTypeDef:
|
|
179
|
+
"""
|
|
180
|
+
If you provide a value for <code>PerformedBy.UserArn</code> you must also have
|
|
181
|
+
<a
|
|
182
|
+
href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">connect:DescribeUser</a>
|
|
183
|
+
permission on the User ARN resource that you provide.
|
|
184
|
+
|
|
185
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/create_case.html)
|
|
186
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#create_case)
|
|
187
|
+
"""
|
|
188
|
+
|
|
189
|
+
def create_domain(
|
|
190
|
+
self, **kwargs: Unpack[CreateDomainRequestRequestTypeDef]
|
|
191
|
+
) -> CreateDomainResponseTypeDef:
|
|
192
|
+
"""
|
|
193
|
+
Creates a domain, which is a container for all case data, such as cases,
|
|
194
|
+
fields, templates and layouts.
|
|
195
|
+
|
|
196
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/create_domain.html)
|
|
197
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#create_domain)
|
|
198
|
+
"""
|
|
199
|
+
|
|
200
|
+
def create_field(
|
|
201
|
+
self, **kwargs: Unpack[CreateFieldRequestRequestTypeDef]
|
|
202
|
+
) -> CreateFieldResponseTypeDef:
|
|
203
|
+
"""
|
|
204
|
+
Creates a field in the Cases domain.
|
|
205
|
+
|
|
206
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/create_field.html)
|
|
207
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#create_field)
|
|
208
|
+
"""
|
|
209
|
+
|
|
210
|
+
def create_layout(
|
|
211
|
+
self, **kwargs: Unpack[CreateLayoutRequestRequestTypeDef]
|
|
212
|
+
) -> CreateLayoutResponseTypeDef:
|
|
213
|
+
"""
|
|
214
|
+
Creates a layout in the Cases domain.
|
|
215
|
+
|
|
216
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/create_layout.html)
|
|
217
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#create_layout)
|
|
218
|
+
"""
|
|
219
|
+
|
|
220
|
+
def create_related_item(
|
|
221
|
+
self, **kwargs: Unpack[CreateRelatedItemRequestRequestTypeDef]
|
|
222
|
+
) -> CreateRelatedItemResponseTypeDef:
|
|
223
|
+
"""
|
|
224
|
+
Creates a related item (comments, tasks, and contacts) and associates it with a
|
|
225
|
+
case.
|
|
226
|
+
|
|
227
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/create_related_item.html)
|
|
228
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#create_related_item)
|
|
229
|
+
"""
|
|
230
|
+
|
|
231
|
+
def create_template(
|
|
232
|
+
self, **kwargs: Unpack[CreateTemplateRequestRequestTypeDef]
|
|
233
|
+
) -> CreateTemplateResponseTypeDef:
|
|
234
|
+
"""
|
|
235
|
+
Creates a template in the Cases domain.
|
|
236
|
+
|
|
237
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/create_template.html)
|
|
238
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#create_template)
|
|
239
|
+
"""
|
|
240
|
+
|
|
241
|
+
def delete_domain(self, **kwargs: Unpack[DeleteDomainRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
242
|
+
"""
|
|
243
|
+
Deletes a Cases domain.
|
|
244
|
+
|
|
245
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/delete_domain.html)
|
|
246
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#delete_domain)
|
|
247
|
+
"""
|
|
248
|
+
|
|
249
|
+
def delete_field(self, **kwargs: Unpack[DeleteFieldRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
250
|
+
"""
|
|
251
|
+
Deletes a field from a cases template.
|
|
252
|
+
|
|
253
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/delete_field.html)
|
|
254
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#delete_field)
|
|
255
|
+
"""
|
|
256
|
+
|
|
257
|
+
def delete_layout(self, **kwargs: Unpack[DeleteLayoutRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
258
|
+
"""
|
|
259
|
+
Deletes a layout from a cases template.
|
|
260
|
+
|
|
261
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/delete_layout.html)
|
|
262
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#delete_layout)
|
|
263
|
+
"""
|
|
264
|
+
|
|
265
|
+
def delete_template(
|
|
266
|
+
self, **kwargs: Unpack[DeleteTemplateRequestRequestTypeDef]
|
|
267
|
+
) -> Dict[str, Any]:
|
|
268
|
+
"""
|
|
269
|
+
Deletes a cases template.
|
|
270
|
+
|
|
271
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/delete_template.html)
|
|
272
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#delete_template)
|
|
273
|
+
"""
|
|
274
|
+
|
|
275
|
+
def get_case(self, **kwargs: Unpack[GetCaseRequestRequestTypeDef]) -> GetCaseResponseTypeDef:
|
|
276
|
+
"""
|
|
277
|
+
Returns information about a specific case if it exists.
|
|
278
|
+
|
|
279
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_case.html)
|
|
280
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_case)
|
|
281
|
+
"""
|
|
282
|
+
|
|
283
|
+
def get_case_audit_events(
|
|
284
|
+
self, **kwargs: Unpack[GetCaseAuditEventsRequestRequestTypeDef]
|
|
285
|
+
) -> GetCaseAuditEventsResponseTypeDef:
|
|
286
|
+
"""
|
|
287
|
+
Returns the audit history about a specific case if it exists.
|
|
288
|
+
|
|
289
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_case_audit_events.html)
|
|
290
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_case_audit_events)
|
|
291
|
+
"""
|
|
292
|
+
|
|
293
|
+
def get_case_event_configuration(
|
|
294
|
+
self, **kwargs: Unpack[GetCaseEventConfigurationRequestRequestTypeDef]
|
|
295
|
+
) -> GetCaseEventConfigurationResponseTypeDef:
|
|
296
|
+
"""
|
|
297
|
+
Returns the case event publishing configuration.
|
|
298
|
+
|
|
299
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_case_event_configuration.html)
|
|
300
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_case_event_configuration)
|
|
301
|
+
"""
|
|
302
|
+
|
|
303
|
+
def get_domain(
|
|
304
|
+
self, **kwargs: Unpack[GetDomainRequestRequestTypeDef]
|
|
305
|
+
) -> GetDomainResponseTypeDef:
|
|
306
|
+
"""
|
|
307
|
+
Returns information about a specific domain if it exists.
|
|
308
|
+
|
|
309
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_domain.html)
|
|
310
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_domain)
|
|
311
|
+
"""
|
|
312
|
+
|
|
313
|
+
def get_layout(
|
|
314
|
+
self, **kwargs: Unpack[GetLayoutRequestRequestTypeDef]
|
|
315
|
+
) -> GetLayoutResponseTypeDef:
|
|
316
|
+
"""
|
|
317
|
+
Returns the details for the requested layout.
|
|
318
|
+
|
|
319
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_layout.html)
|
|
320
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_layout)
|
|
321
|
+
"""
|
|
322
|
+
|
|
323
|
+
def get_template(
|
|
324
|
+
self, **kwargs: Unpack[GetTemplateRequestRequestTypeDef]
|
|
325
|
+
) -> GetTemplateResponseTypeDef:
|
|
326
|
+
"""
|
|
327
|
+
Returns the details for the requested template.
|
|
328
|
+
|
|
329
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_template.html)
|
|
330
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_template)
|
|
331
|
+
"""
|
|
332
|
+
|
|
333
|
+
def list_cases_for_contact(
|
|
334
|
+
self, **kwargs: Unpack[ListCasesForContactRequestRequestTypeDef]
|
|
335
|
+
) -> ListCasesForContactResponseTypeDef:
|
|
336
|
+
"""
|
|
337
|
+
Lists cases for a given contact.
|
|
338
|
+
|
|
339
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/list_cases_for_contact.html)
|
|
340
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#list_cases_for_contact)
|
|
341
|
+
"""
|
|
342
|
+
|
|
343
|
+
def list_domains(
|
|
344
|
+
self, **kwargs: Unpack[ListDomainsRequestRequestTypeDef]
|
|
345
|
+
) -> ListDomainsResponseTypeDef:
|
|
346
|
+
"""
|
|
347
|
+
Lists all cases domains in the Amazon Web Services account.
|
|
348
|
+
|
|
349
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/list_domains.html)
|
|
350
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#list_domains)
|
|
351
|
+
"""
|
|
352
|
+
|
|
353
|
+
def list_field_options(
|
|
354
|
+
self, **kwargs: Unpack[ListFieldOptionsRequestRequestTypeDef]
|
|
355
|
+
) -> ListFieldOptionsResponseTypeDef:
|
|
356
|
+
"""
|
|
357
|
+
Lists all of the field options for a field identifier in the domain.
|
|
358
|
+
|
|
359
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/list_field_options.html)
|
|
360
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#list_field_options)
|
|
361
|
+
"""
|
|
362
|
+
|
|
363
|
+
def list_fields(
|
|
364
|
+
self, **kwargs: Unpack[ListFieldsRequestRequestTypeDef]
|
|
365
|
+
) -> ListFieldsResponseTypeDef:
|
|
366
|
+
"""
|
|
367
|
+
Lists all fields in a Cases domain.
|
|
368
|
+
|
|
369
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/list_fields.html)
|
|
370
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#list_fields)
|
|
371
|
+
"""
|
|
372
|
+
|
|
373
|
+
def list_layouts(
|
|
374
|
+
self, **kwargs: Unpack[ListLayoutsRequestRequestTypeDef]
|
|
375
|
+
) -> ListLayoutsResponseTypeDef:
|
|
376
|
+
"""
|
|
377
|
+
Lists all layouts in the given cases domain.
|
|
378
|
+
|
|
379
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/list_layouts.html)
|
|
380
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#list_layouts)
|
|
381
|
+
"""
|
|
382
|
+
|
|
383
|
+
def list_tags_for_resource(
|
|
384
|
+
self, **kwargs: Unpack[ListTagsForResourceRequestRequestTypeDef]
|
|
385
|
+
) -> ListTagsForResourceResponseTypeDef:
|
|
386
|
+
"""
|
|
387
|
+
Lists tags for a resource.
|
|
388
|
+
|
|
389
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/list_tags_for_resource.html)
|
|
390
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#list_tags_for_resource)
|
|
391
|
+
"""
|
|
392
|
+
|
|
393
|
+
def list_templates(
|
|
394
|
+
self, **kwargs: Unpack[ListTemplatesRequestRequestTypeDef]
|
|
395
|
+
) -> ListTemplatesResponseTypeDef:
|
|
396
|
+
"""
|
|
397
|
+
Lists all of the templates in a Cases domain.
|
|
398
|
+
|
|
399
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/list_templates.html)
|
|
400
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#list_templates)
|
|
401
|
+
"""
|
|
402
|
+
|
|
403
|
+
def put_case_event_configuration(
|
|
404
|
+
self, **kwargs: Unpack[PutCaseEventConfigurationRequestRequestTypeDef]
|
|
405
|
+
) -> Dict[str, Any]:
|
|
406
|
+
"""
|
|
407
|
+
Adds case event publishing configuration.
|
|
408
|
+
|
|
409
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/put_case_event_configuration.html)
|
|
410
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#put_case_event_configuration)
|
|
411
|
+
"""
|
|
412
|
+
|
|
413
|
+
def search_cases(
|
|
414
|
+
self, **kwargs: Unpack[SearchCasesRequestRequestTypeDef]
|
|
415
|
+
) -> SearchCasesResponseTypeDef:
|
|
416
|
+
"""
|
|
417
|
+
Searches for cases within their associated Cases domain.
|
|
418
|
+
|
|
419
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/search_cases.html)
|
|
420
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#search_cases)
|
|
421
|
+
"""
|
|
422
|
+
|
|
423
|
+
def search_related_items(
|
|
424
|
+
self, **kwargs: Unpack[SearchRelatedItemsRequestRequestTypeDef]
|
|
425
|
+
) -> SearchRelatedItemsResponseTypeDef:
|
|
426
|
+
"""
|
|
427
|
+
Searches for related items that are associated with a case.
|
|
428
|
+
|
|
429
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/search_related_items.html)
|
|
430
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#search_related_items)
|
|
431
|
+
"""
|
|
432
|
+
|
|
433
|
+
def tag_resource(
|
|
434
|
+
self, **kwargs: Unpack[TagResourceRequestRequestTypeDef]
|
|
435
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
436
|
+
"""
|
|
437
|
+
Adds tags to a resource.
|
|
438
|
+
|
|
439
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/tag_resource.html)
|
|
440
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#tag_resource)
|
|
441
|
+
"""
|
|
442
|
+
|
|
443
|
+
def untag_resource(
|
|
444
|
+
self, **kwargs: Unpack[UntagResourceRequestRequestTypeDef]
|
|
445
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
446
|
+
"""
|
|
447
|
+
Untags a resource.
|
|
448
|
+
|
|
449
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/untag_resource.html)
|
|
450
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#untag_resource)
|
|
451
|
+
"""
|
|
452
|
+
|
|
453
|
+
def update_case(self, **kwargs: Unpack[UpdateCaseRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
454
|
+
"""
|
|
455
|
+
If you provide a value for <code>PerformedBy.UserArn</code> you must also have
|
|
456
|
+
<a
|
|
457
|
+
href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">connect:DescribeUser</a>
|
|
458
|
+
permission on the User ARN resource that you provide.
|
|
459
|
+
|
|
460
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/update_case.html)
|
|
461
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#update_case)
|
|
462
|
+
"""
|
|
463
|
+
|
|
464
|
+
def update_field(self, **kwargs: Unpack[UpdateFieldRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
465
|
+
"""
|
|
466
|
+
Updates the properties of an existing field.
|
|
467
|
+
|
|
468
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/update_field.html)
|
|
469
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#update_field)
|
|
470
|
+
"""
|
|
471
|
+
|
|
472
|
+
def update_layout(self, **kwargs: Unpack[UpdateLayoutRequestRequestTypeDef]) -> Dict[str, Any]:
|
|
473
|
+
"""
|
|
474
|
+
Updates the attributes of an existing layout.
|
|
475
|
+
|
|
476
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/update_layout.html)
|
|
477
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#update_layout)
|
|
478
|
+
"""
|
|
479
|
+
|
|
480
|
+
def update_template(
|
|
481
|
+
self, **kwargs: Unpack[UpdateTemplateRequestRequestTypeDef]
|
|
482
|
+
) -> Dict[str, Any]:
|
|
483
|
+
"""
|
|
484
|
+
Updates the attributes of an existing template.
|
|
485
|
+
|
|
486
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/update_template.html)
|
|
487
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#update_template)
|
|
488
|
+
"""
|
|
489
|
+
|
|
490
|
+
@overload
|
|
491
|
+
def get_paginator(self, operation_name: Literal["search_cases"]) -> SearchCasesPaginator:
|
|
492
|
+
"""
|
|
493
|
+
Create a paginator for an operation.
|
|
494
|
+
|
|
495
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_paginator.html)
|
|
496
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_paginator)
|
|
497
|
+
"""
|
|
498
|
+
|
|
499
|
+
@overload
|
|
500
|
+
def get_paginator(
|
|
501
|
+
self, operation_name: Literal["search_related_items"]
|
|
502
|
+
) -> SearchRelatedItemsPaginator:
|
|
503
|
+
"""
|
|
504
|
+
Create a paginator for an operation.
|
|
505
|
+
|
|
506
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/connectcases/client/get_paginator.html)
|
|
507
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_connectcases/client/#get_paginator)
|
|
508
|
+
"""
|