@aws-sdk/client-connectcases 3.840.0 → 3.842.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 (62) hide show
  1. package/README.md +17 -19
  2. package/dist-cjs/index.js +77 -0
  3. package/dist-es/ConnectCases.js +4 -0
  4. package/dist-es/commands/DeleteCaseCommand.js +22 -0
  5. package/dist-es/commands/DeleteRelatedItemCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/protocols/Aws_restJson1.js +41 -0
  8. package/dist-types/ConnectCases.d.ts +15 -19
  9. package/dist-types/ConnectCasesClient.d.ts +5 -21
  10. package/dist-types/commands/BatchGetCaseRuleCommand.d.ts +3 -7
  11. package/dist-types/commands/BatchGetFieldCommand.d.ts +2 -4
  12. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +4 -8
  13. package/dist-types/commands/CreateCaseCommand.d.ts +4 -27
  14. package/dist-types/commands/CreateCaseRuleCommand.d.ts +5 -12
  15. package/dist-types/commands/CreateDomainCommand.d.ts +4 -17
  16. package/dist-types/commands/CreateFieldCommand.d.ts +5 -11
  17. package/dist-types/commands/CreateLayoutCommand.d.ts +5 -23
  18. package/dist-types/commands/CreateRelatedItemCommand.d.ts +4 -26
  19. package/dist-types/commands/CreateTemplateCommand.d.ts +5 -38
  20. package/dist-types/commands/DeleteCaseCommand.d.ts +86 -0
  21. package/dist-types/commands/DeleteCaseRuleCommand.d.ts +4 -10
  22. package/dist-types/commands/DeleteDomainCommand.d.ts +4 -12
  23. package/dist-types/commands/DeleteFieldCommand.d.ts +5 -62
  24. package/dist-types/commands/DeleteLayoutCommand.d.ts +4 -22
  25. package/dist-types/commands/DeleteRelatedItemCommand.d.ts +87 -0
  26. package/dist-types/commands/DeleteTemplateCommand.d.ts +4 -23
  27. package/dist-types/commands/GetCaseAuditEventsCommand.d.ts +2 -4
  28. package/dist-types/commands/GetCaseCommand.d.ts +2 -4
  29. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +2 -4
  30. package/dist-types/commands/GetDomainCommand.d.ts +2 -4
  31. package/dist-types/commands/GetLayoutCommand.d.ts +2 -4
  32. package/dist-types/commands/GetTemplateCommand.d.ts +3 -27
  33. package/dist-types/commands/ListCaseRulesCommand.d.ts +3 -7
  34. package/dist-types/commands/ListCasesForContactCommand.d.ts +2 -4
  35. package/dist-types/commands/ListDomainsCommand.d.ts +2 -4
  36. package/dist-types/commands/ListFieldOptionsCommand.d.ts +2 -4
  37. package/dist-types/commands/ListFieldsCommand.d.ts +2 -4
  38. package/dist-types/commands/ListLayoutsCommand.d.ts +3 -6
  39. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -4
  40. package/dist-types/commands/ListTemplatesCommand.d.ts +3 -29
  41. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +4 -11
  42. package/dist-types/commands/SearchCasesCommand.d.ts +3 -11
  43. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +3 -9
  44. package/dist-types/commands/TagResourceCommand.d.ts +2 -4
  45. package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
  46. package/dist-types/commands/UpdateCaseCommand.d.ts +3 -11
  47. package/dist-types/commands/UpdateCaseRuleCommand.d.ts +4 -10
  48. package/dist-types/commands/UpdateFieldCommand.d.ts +3 -7
  49. package/dist-types/commands/UpdateLayoutCommand.d.ts +5 -18
  50. package/dist-types/commands/UpdateTemplateCommand.d.ts +4 -35
  51. package/dist-types/commands/index.d.ts +2 -0
  52. package/dist-types/index.d.ts +1 -19
  53. package/dist-types/models/models_0.d.ts +107 -159
  54. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  55. package/dist-types/ts3.4/ConnectCases.d.ts +34 -0
  56. package/dist-types/ts3.4/ConnectCasesClient.d.ts +12 -0
  57. package/dist-types/ts3.4/commands/DeleteCaseCommand.d.ts +47 -0
  58. package/dist-types/ts3.4/commands/DeleteRelatedItemCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  60. package/dist-types/ts3.4/models/models_0.d.ts +11 -0
  61. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  62. package/package.json +1 -1
@@ -27,9 +27,7 @@ declare const CreateCaseRuleCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more
31
- * information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a
32
- * case template</a>.</p>
30
+ * <p>Creates a new case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a case template</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -93,21 +91,16 @@ declare const CreateCaseRuleCommand_base: {
93
91
  * <p>You do not have sufficient access to perform this action.</p>
94
92
  *
95
93
  * @throws {@link ConflictException} (client fault)
96
- * <p>The requested operation would cause a conflict with the current state of a service
97
- * resource associated with the request. Resolve the conflict before retrying this request. See
98
- * the accompanying error message for details.</p>
94
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
99
95
  *
100
96
  * @throws {@link InternalServerException} (server fault)
101
- * <p>We couldn't process your request because of an issue with the server. Try again
102
- * later.</p>
97
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
103
98
  *
104
99
  * @throws {@link ResourceNotFoundException} (client fault)
105
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
106
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
100
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
107
101
  *
108
102
  * @throws {@link ServiceQuotaExceededException} (client fault)
109
- * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
110
- * Administrator Guide</i>.</p>
103
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
111
104
  *
112
105
  * @throws {@link ThrottlingException} (client fault)
113
106
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,16 +27,7 @@ declare const CreateDomainCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a domain, which is a container for all case data, such as cases, fields, templates
31
- * and layouts. Each Amazon Connect instance can be associated with only one Cases
32
- * domain.</p>
33
- * <important>
34
- * <p>This will not associate your connect instance to Cases domain. Instead, use the
35
- * Amazon Connect
36
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html">CreateIntegrationAssociation</a> API. You need specific IAM
37
- * permissions to successfully associate the Cases domain. For more information, see
38
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam">Onboard to Cases</a>.</p>
39
- * </important>
30
+ * <p>Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.</p> <important> <p>This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html">CreateIntegrationAssociation</a> API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam">Onboard to Cases</a>.</p> </important>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -66,17 +57,13 @@ declare const CreateDomainCommand_base: {
66
57
  * <p>You do not have sufficient access to perform this action.</p>
67
58
  *
68
59
  * @throws {@link ConflictException} (client fault)
69
- * <p>The requested operation would cause a conflict with the current state of a service
70
- * resource associated with the request. Resolve the conflict before retrying this request. See
71
- * the accompanying error message for details.</p>
60
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
72
61
  *
73
62
  * @throws {@link InternalServerException} (server fault)
74
- * <p>We couldn't process your request because of an issue with the server. Try again
75
- * later.</p>
63
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
76
64
  *
77
65
  * @throws {@link ServiceQuotaExceededException} (client fault)
78
- * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
79
- * Administrator Guide</i>.</p>
66
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
80
67
  *
81
68
  * @throws {@link ThrottlingException} (client fault)
82
69
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,8 +27,7 @@ declare const CreateFieldCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a field in the Cases domain. This field is used to define the case object
31
- * model (that is, defines what data can be captured on cases) in a Cases domain. </p>
30
+ * <p>Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain. </p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -60,21 +59,16 @@ declare const CreateFieldCommand_base: {
60
59
  * <p>You do not have sufficient access to perform this action.</p>
61
60
  *
62
61
  * @throws {@link ConflictException} (client fault)
63
- * <p>The requested operation would cause a conflict with the current state of a service
64
- * resource associated with the request. Resolve the conflict before retrying this request. See
65
- * the accompanying error message for details.</p>
62
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
66
63
  *
67
64
  * @throws {@link InternalServerException} (server fault)
68
- * <p>We couldn't process your request because of an issue with the server. Try again
69
- * later.</p>
65
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
70
66
  *
71
67
  * @throws {@link ResourceNotFoundException} (client fault)
72
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
73
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
68
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
74
69
  *
75
70
  * @throws {@link ServiceQuotaExceededException} (client fault)
76
- * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
77
- * Administrator Guide</i>.</p>
71
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
78
72
  *
79
73
  * @throws {@link ThrottlingException} (client fault)
80
74
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,20 +27,7 @@ declare const CreateLayoutCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a layout in the Cases domain. Layouts define the following configuration in
31
- * the top section and More Info tab of the Cases user interface:</p>
32
- * <ul>
33
- * <li>
34
- * <p>Fields to display to the users</p>
35
- * </li>
36
- * <li>
37
- * <p>Field ordering</p>
38
- * </li>
39
- * </ul>
40
- * <note>
41
- * <p>Title and Status fields cannot be part of layouts since they are not
42
- * configurable.</p>
43
- * </note>
30
+ * <p>Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:</p> <ul> <li> <p>Fields to display to the users</p> </li> <li> <p>Field ordering</p> </li> </ul> <note> <p>Title and Status fields cannot be part of layouts since they are not configurable.</p> </note>
44
31
  * @example
45
32
  * Use a bare-bones client and the command you need to make an API call.
46
33
  * ```javascript
@@ -102,21 +89,16 @@ declare const CreateLayoutCommand_base: {
102
89
  * <p>You do not have sufficient access to perform this action.</p>
103
90
  *
104
91
  * @throws {@link ConflictException} (client fault)
105
- * <p>The requested operation would cause a conflict with the current state of a service
106
- * resource associated with the request. Resolve the conflict before retrying this request. See
107
- * the accompanying error message for details.</p>
92
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
108
93
  *
109
94
  * @throws {@link InternalServerException} (server fault)
110
- * <p>We couldn't process your request because of an issue with the server. Try again
111
- * later.</p>
95
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
112
96
  *
113
97
  * @throws {@link ResourceNotFoundException} (client fault)
114
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
115
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
98
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
116
99
  *
117
100
  * @throws {@link ServiceQuotaExceededException} (client fault)
118
- * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
119
- * Administrator Guide</i>.</p>
101
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
120
102
  *
121
103
  * @throws {@link ThrottlingException} (client fault)
122
104
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,26 +27,7 @@ declare const CreateRelatedItemCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a related item (comments, tasks, and contacts) and associates it with a
31
- * case.</p>
32
- * <note>
33
- * <ul>
34
- * <li>
35
- * <p>A Related Item is a resource that is associated with a case. It may or may not have
36
- * an external identifier linking it to an external resource (for example, a
37
- * <code>contactArn</code>). All Related Items have their own internal identifier, the
38
- * <code>relatedItemArn</code>. Examples of related items include <code>comments</code>
39
- * and <code>contacts</code>.</p>
40
- * </li>
41
- * <li>
42
- * <p>If you provide a value for <code>performedBy.userArn</code> you must also have
43
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">DescribeUser</a> permission on the ARN of the user that you provide.</p>
44
- * </li>
45
- * <li>
46
- * <p>The <code>type</code> field is reserved for internal use only.</p>
47
- * </li>
48
- * </ul>
49
- * </note>
30
+ * <p>Creates a related item (comments, tasks, and contacts) and associates it with a case.</p> <note> <ul> <li> <p>A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a <code>contactArn</code>). All Related Items have their own internal identifier, the <code>relatedItemArn</code>. Examples of related items include <code>comments</code> and <code>contacts</code>.</p> </li> <li> <p>If you provide a value for <code>performedBy.userArn</code> you must also have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">DescribeUser</a> permission on the ARN of the user that you provide.</p> </li> <li> <p>The <code>type</code> field is reserved for internal use only.</p> </li> </ul> </note>
50
31
  * @example
51
32
  * Use a bare-bones client and the command you need to make an API call.
52
33
  * ```javascript
@@ -110,16 +91,13 @@ declare const CreateRelatedItemCommand_base: {
110
91
  * <p>You do not have sufficient access to perform this action.</p>
111
92
  *
112
93
  * @throws {@link InternalServerException} (server fault)
113
- * <p>We couldn't process your request because of an issue with the server. Try again
114
- * later.</p>
94
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
115
95
  *
116
96
  * @throws {@link ResourceNotFoundException} (client fault)
117
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
118
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
97
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
119
98
  *
120
99
  * @throws {@link ServiceQuotaExceededException} (client fault)
121
- * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
122
- * Administrator Guide</i>.</p>
100
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
123
101
  *
124
102
  * @throws {@link ThrottlingException} (client fault)
125
103
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,35 +27,7 @@ declare const CreateTemplateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a template in the Cases domain. This template is used to define the case object
31
- * model (that is, to define what data can be captured on cases) in a Cases domain. A template
32
- * must have a unique name within a domain, and it must reference existing field IDs and layout
33
- * IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A
34
- * template can be either Active or Inactive, as indicated by its status. Inactive templates
35
- * cannot be used to create cases.</p>
36
- * <p> Other template APIs are: </p>
37
- * <ul>
38
- * <li>
39
- * <p>
40
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a>
41
- * </p>
42
- * </li>
43
- * <li>
44
- * <p>
45
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html">GetTemplate</a>
46
- * </p>
47
- * </li>
48
- * <li>
49
- * <p>
50
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html">ListTemplates</a>
51
- * </p>
52
- * </li>
53
- * <li>
54
- * <p>
55
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html">UpdateTemplate</a>
56
- * </p>
57
- * </li>
58
- * </ul>
30
+ * <p>Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.</p> <p> Other template APIs are: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html">GetTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html">ListTemplates</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html">UpdateTemplate</a> </p> </li> </ul>
59
31
  * @example
60
32
  * Use a bare-bones client and the command you need to make an API call.
61
33
  * ```javascript
@@ -101,21 +73,16 @@ declare const CreateTemplateCommand_base: {
101
73
  * <p>You do not have sufficient access to perform this action.</p>
102
74
  *
103
75
  * @throws {@link ConflictException} (client fault)
104
- * <p>The requested operation would cause a conflict with the current state of a service
105
- * resource associated with the request. Resolve the conflict before retrying this request. See
106
- * the accompanying error message for details.</p>
76
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
107
77
  *
108
78
  * @throws {@link InternalServerException} (server fault)
109
- * <p>We couldn't process your request because of an issue with the server. Try again
110
- * later.</p>
79
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
111
80
  *
112
81
  * @throws {@link ResourceNotFoundException} (client fault)
113
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
114
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
82
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
115
83
  *
116
84
  * @throws {@link ServiceQuotaExceededException} (client fault)
117
- * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
118
- * Administrator Guide</i>.</p>
85
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
119
86
  *
120
87
  * @throws {@link ThrottlingException} (client fault)
121
88
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -0,0 +1,86 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
4
+ import { DeleteCaseRequest, DeleteCaseResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteCaseCommand}.
14
+ */
15
+ export interface DeleteCaseCommandInput extends DeleteCaseRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteCaseCommand}.
21
+ */
22
+ export interface DeleteCaseCommandOutput extends DeleteCaseResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteCaseCommand_base: {
25
+ new (input: DeleteCaseCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteCaseCommandInput, DeleteCaseCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DeleteCaseCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteCaseCommandInput, DeleteCaseCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:</p> <ul> <li> <p>Retrieve related items</p> </li> <li> <p>Access audit history</p> </li> <li> <p>Perform any operations that require the CaseID</p> </li> </ul> <important> <p>This action is irreversible. Once you delete a case, you cannot recover its data.</p> </important>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConnectCasesClient, DeleteCaseCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
35
+ * // const { ConnectCasesClient, DeleteCaseCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
36
+ * const client = new ConnectCasesClient(config);
37
+ * const input = { // DeleteCaseRequest
38
+ * domainId: "STRING_VALUE", // required
39
+ * caseId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteCaseCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteCaseCommandInput - {@link DeleteCaseCommandInput}
48
+ * @returns {@link DeleteCaseCommandOutput}
49
+ * @see {@link DeleteCaseCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteCaseCommandOutput} for command's `response` shape.
51
+ * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
52
+ *
53
+ * @throws {@link AccessDeniedException} (client fault)
54
+ * <p>You do not have sufficient access to perform this action.</p>
55
+ *
56
+ * @throws {@link InternalServerException} (server fault)
57
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
58
+ *
59
+ * @throws {@link ResourceNotFoundException} (client fault)
60
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
61
+ *
62
+ * @throws {@link ThrottlingException} (client fault)
63
+ * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
64
+ *
65
+ * @throws {@link ValidationException} (client fault)
66
+ * <p>The request isn't valid. Check the syntax and try again.</p>
67
+ *
68
+ * @throws {@link ConnectCasesServiceException}
69
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
70
+ *
71
+ *
72
+ * @public
73
+ */
74
+ export declare class DeleteCaseCommand extends DeleteCaseCommand_base {
75
+ /** @internal type navigation helper, not in runtime. */
76
+ protected static __types: {
77
+ api: {
78
+ input: DeleteCaseRequest;
79
+ output: {};
80
+ };
81
+ sdk: {
82
+ input: DeleteCaseCommandInput;
83
+ output: DeleteCaseCommandOutput;
84
+ };
85
+ };
86
+ }
@@ -27,9 +27,7 @@ declare const DeleteCaseRuleCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more
31
- * information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a
32
- * case template</a>.</p>
30
+ * <p>Deletes a case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a case template</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -56,17 +54,13 @@ declare const DeleteCaseRuleCommand_base: {
56
54
  * <p>You do not have sufficient access to perform this action.</p>
57
55
  *
58
56
  * @throws {@link ConflictException} (client fault)
59
- * <p>The requested operation would cause a conflict with the current state of a service
60
- * resource associated with the request. Resolve the conflict before retrying this request. See
61
- * the accompanying error message for details.</p>
57
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
62
58
  *
63
59
  * @throws {@link InternalServerException} (server fault)
64
- * <p>We couldn't process your request because of an issue with the server. Try again
65
- * later.</p>
60
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
66
61
  *
67
62
  * @throws {@link ResourceNotFoundException} (client fault)
68
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
69
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
63
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
70
64
  *
71
65
  * @throws {@link ThrottlingException} (client fault)
72
66
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,11 +27,7 @@ declare const DeleteDomainCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a Cases domain.</p>
31
- * <note>
32
- * <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this
33
- * Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p>
34
- * </note>
30
+ * <p>Deletes a Cases domain.</p> <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -57,17 +53,13 @@ declare const DeleteDomainCommand_base: {
57
53
  * <p>You do not have sufficient access to perform this action.</p>
58
54
  *
59
55
  * @throws {@link ConflictException} (client fault)
60
- * <p>The requested operation would cause a conflict with the current state of a service
61
- * resource associated with the request. Resolve the conflict before retrying this request. See
62
- * the accompanying error message for details.</p>
56
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
63
57
  *
64
58
  * @throws {@link InternalServerException} (server fault)
65
- * <p>We couldn't process your request because of an issue with the server. Try again
66
- * later.</p>
59
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
67
60
  *
68
61
  * @throws {@link ResourceNotFoundException} (client fault)
69
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
70
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
62
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
71
63
  *
72
64
  * @throws {@link ThrottlingException} (client fault)
73
65
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,59 +27,7 @@ declare const DeleteFieldCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a field from a cases template. You can delete up to 100 fields per domain.</p>
31
- * <p>After a field is deleted:</p>
32
- * <ul>
33
- * <li>
34
- * <p>You can still retrieve the field by calling <code>BatchGetField</code>.</p>
35
- * </li>
36
- * <li>
37
- * <p>You cannot update a deleted field by calling <code>UpdateField</code>; it throws a
38
- * <code>ValidationException</code>.</p>
39
- * </li>
40
- * <li>
41
- * <p>Deleted fields are not included in the <code>ListFields</code> response.</p>
42
- * </li>
43
- * <li>
44
- * <p>Calling <code>CreateCase</code> with a deleted field throws a
45
- * <code>ValidationException</code> denoting which field IDs in the request have been
46
- * deleted.</p>
47
- * </li>
48
- * <li>
49
- * <p>Calling <code>GetCase</code> with a deleted field ID returns the deleted field's value
50
- * if one exists.</p>
51
- * </li>
52
- * <li>
53
- * <p>Calling <code>UpdateCase</code> with a deleted field ID throws a
54
- * <code>ValidationException</code> if the case does not already contain a value for the
55
- * deleted field. Otherwise it succeeds, allowing you to update or remove (using
56
- * <code>emptyValue: \{\}</code>) the field's value from the case.</p>
57
- * </li>
58
- * <li>
59
- * <p>
60
- * <code>GetTemplate</code> does not return field IDs for deleted fields.</p>
61
- * </li>
62
- * <li>
63
- * <p>
64
- * <code>GetLayout</code> does not return field IDs for deleted fields.</p>
65
- * </li>
66
- * <li>
67
- * <p>Calling <code>SearchCases</code> with the deleted field ID as a filter returns any
68
- * cases that have a value for the deleted field that matches the filter criteria.</p>
69
- * </li>
70
- * <li>
71
- * <p>Calling <code>SearchCases</code> with a <code>searchTerm</code> value that matches a
72
- * deleted field's value on a case returns the case in the response.</p>
73
- * </li>
74
- * <li>
75
- * <p>Calling <code>BatchPutFieldOptions</code> with a deleted field ID throw a
76
- * <code>ValidationException</code>.</p>
77
- * </li>
78
- * <li>
79
- * <p>Calling <code>GetCaseEventConfiguration</code> does not return field IDs for deleted
80
- * fields.</p>
81
- * </li>
82
- * </ul>
30
+ * <p>Deletes a field from a cases template. You can delete up to 100 fields per domain.</p> <p>After a field is deleted:</p> <ul> <li> <p>You can still retrieve the field by calling <code>BatchGetField</code>.</p> </li> <li> <p>You cannot update a deleted field by calling <code>UpdateField</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted fields are not included in the <code>ListFields</code> response.</p> </li> <li> <p>Calling <code>CreateCase</code> with a deleted field throws a <code>ValidationException</code> denoting which field IDs in the request have been deleted.</p> </li> <li> <p>Calling <code>GetCase</code> with a deleted field ID returns the deleted field's value if one exists.</p> </li> <li> <p>Calling <code>UpdateCase</code> with a deleted field ID throws a <code>ValidationException</code> if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using <code>emptyValue: \{\}</code>) the field's value from the case.</p> </li> <li> <p> <code>GetTemplate</code> does not return field IDs for deleted fields.</p> </li> <li> <p> <code>GetLayout</code> does not return field IDs for deleted fields.</p> </li> <li> <p>Calling <code>SearchCases</code> with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.</p> </li> <li> <p>Calling <code>SearchCases</code> with a <code>searchTerm</code> value that matches a deleted field's value on a case returns the case in the response.</p> </li> <li> <p>Calling <code>BatchPutFieldOptions</code> with a deleted field ID throw a <code>ValidationException</code>.</p> </li> <li> <p>Calling <code>GetCaseEventConfiguration</code> does not return field IDs for deleted fields.</p> </li> </ul>
83
31
  * @example
84
32
  * Use a bare-bones client and the command you need to make an API call.
85
33
  * ```javascript
@@ -106,21 +54,16 @@ declare const DeleteFieldCommand_base: {
106
54
  * <p>You do not have sufficient access to perform this action.</p>
107
55
  *
108
56
  * @throws {@link ConflictException} (client fault)
109
- * <p>The requested operation would cause a conflict with the current state of a service
110
- * resource associated with the request. Resolve the conflict before retrying this request. See
111
- * the accompanying error message for details.</p>
57
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
112
58
  *
113
59
  * @throws {@link InternalServerException} (server fault)
114
- * <p>We couldn't process your request because of an issue with the server. Try again
115
- * later.</p>
60
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
116
61
  *
117
62
  * @throws {@link ResourceNotFoundException} (client fault)
118
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
119
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
63
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
120
64
  *
121
65
  * @throws {@link ServiceQuotaExceededException} (client fault)
122
- * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
123
- * Administrator Guide</i>.</p>
66
+ * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
124
67
  *
125
68
  * @throws {@link ThrottlingException} (client fault)
126
69
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,21 +27,7 @@ declare const DeleteLayoutCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a layout from a cases template. You can delete up to 100 layouts per
31
- * domain.</p>
32
- * <p>After a layout is deleted:</p>
33
- * <ul>
34
- * <li>
35
- * <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p>
36
- * </li>
37
- * <li>
38
- * <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a
39
- * <code>ValidationException</code>.</p>
40
- * </li>
41
- * <li>
42
- * <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p>
43
- * </li>
44
- * </ul>
30
+ * <p>Deletes a layout from a cases template. You can delete up to 100 layouts per domain.</p> <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>
45
31
  * @example
46
32
  * Use a bare-bones client and the command you need to make an API call.
47
33
  * ```javascript
@@ -68,17 +54,13 @@ declare const DeleteLayoutCommand_base: {
68
54
  * <p>You do not have sufficient access to perform this action.</p>
69
55
  *
70
56
  * @throws {@link ConflictException} (client fault)
71
- * <p>The requested operation would cause a conflict with the current state of a service
72
- * resource associated with the request. Resolve the conflict before retrying this request. See
73
- * the accompanying error message for details.</p>
57
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
74
58
  *
75
59
  * @throws {@link InternalServerException} (server fault)
76
- * <p>We couldn't process your request because of an issue with the server. Try again
77
- * later.</p>
60
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
78
61
  *
79
62
  * @throws {@link ResourceNotFoundException} (client fault)
80
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
81
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
63
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
82
64
  *
83
65
  * @throws {@link ThrottlingException} (client fault)
84
66
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>