|
5 | 5 | "BatchGetCaseRule": "<p>Gets a batch of case rules. 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>", |
6 | 6 | "BatchGetField": "<p>Returns the description for the list of fields in the request parameters. </p>", |
7 | 7 | "BatchPutFieldOptions": "<p>Creates and updates a set of field options for a single select field in a Cases domain.</p>", |
8 | | - "CreateCase": "<note> <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\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>", |
| 8 | + "CreateCase": "<p><note> <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\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul></p>", |
9 | 9 | "CreateCaseRule": "<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>", |
10 | 10 | "CreateDomain": "<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>", |
11 | 11 | "CreateField": "<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>", |
12 | 12 | "CreateLayout": "<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>", |
13 | 13 | "CreateRelatedItem": "<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>", |
14 | 14 | "CreateTemplate": "<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>", |
| 15 | + "DeleteCase": "<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>", |
15 | 16 | "DeleteCaseRule": "<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>", |
16 | 17 | "DeleteDomain": "<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>", |
17 | 18 | "DeleteField": "<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>", |
18 | 19 | "DeleteLayout": "<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>", |
| 20 | + "DeleteRelatedItem": "<p>Deletes the related item resource under a case.</p> <note> <p>This API cannot be used on a FILE type related attachment. To delete this type of file, use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteAttachedFile.html\">DeleteAttachedFile</a> API</p> </note>", |
19 | 21 | "DeleteTemplate": "<p>Deletes a cases template. You can delete up to 100 templates per domain.</p> <p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul>", |
20 | 22 | "GetCase": "<p>Returns information about a specific case if it exists. </p>", |
21 | 23 | "GetCaseAuditEvents": "<p>Returns the audit history about a specific case if it exists.</p>", |
|
36 | 38 | "SearchRelatedItems": "<p>Searches for related items that are associated with a case.</p> <note> <p>If no filters are provided, this returns all related items associated with a case.</p> </note>", |
37 | 39 | "TagResource": "<p>Adds tags to a resource.</p>", |
38 | 40 | "UntagResource": "<p>Untags a resource.</p>", |
39 | | - "UpdateCase": "<note> <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\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>", |
| 41 | + "UpdateCase": "<p><note> <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\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p></p>", |
40 | 42 | "UpdateCaseRule": "<p>Updates 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>", |
41 | 43 | "UpdateField": "<p>Updates the properties of an existing field. </p>", |
42 | 44 | "UpdateLayout": "<p>Updates the attributes of an existing layout.</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> <p>A <code>ValidationException</code> is returned when you add non-existent <code>fieldIds</code> to a layout.</p> <note> <p>Title and Status fields cannot be part of layouts because they are not configurable.</p> </note>", |
|
278 | 280 | "CaseSummary$caseId": "<p>A unique identifier of the case.</p>", |
279 | 281 | "CreateCaseResponse$caseId": "<p>A unique identifier of the case.</p>", |
280 | 282 | "CreateRelatedItemRequest$caseId": "<p>A unique identifier of the case.</p>", |
| 283 | + "DeleteCaseRequest$caseId": "<p>A unique identifier of the case.</p>", |
| 284 | + "DeleteRelatedItemRequest$caseId": "<p>A unique identifier of the case.</p>", |
281 | 285 | "GetCaseAuditEventsRequest$caseId": "<p>A unique identifier of the case.</p>", |
282 | 286 | "GetCaseRequest$caseId": "<p>A unique identifier of the case.</p>", |
283 | 287 | "SearchCasesResponseItem$caseId": "<p>A unique identifier of the case.</p>", |
|
536 | 540 | "UserUnion$customEntity": "<p>Any provided entity.</p>" |
537 | 541 | } |
538 | 542 | }, |
| 543 | + "DeleteCaseRequest": { |
| 544 | + "base": null, |
| 545 | + "refs": { |
| 546 | + } |
| 547 | + }, |
| 548 | + "DeleteCaseResponse": { |
| 549 | + "base": null, |
| 550 | + "refs": { |
| 551 | + } |
| 552 | + }, |
539 | 553 | "DeleteCaseRuleRequest": { |
540 | 554 | "base": null, |
541 | 555 | "refs": { |
|
576 | 590 | "refs": { |
577 | 591 | } |
578 | 592 | }, |
| 593 | + "DeleteRelatedItemRequest": { |
| 594 | + "base": null, |
| 595 | + "refs": { |
| 596 | + } |
| 597 | + }, |
| 598 | + "DeleteRelatedItemResponse": { |
| 599 | + "base": null, |
| 600 | + "refs": { |
| 601 | + } |
| 602 | + }, |
579 | 603 | "DeleteTemplateRequest": { |
580 | 604 | "base": null, |
581 | 605 | "refs": { |
|
616 | 640 | "CreateLayoutRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
617 | 641 | "CreateRelatedItemRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
618 | 642 | "CreateTemplateRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
| 643 | + "DeleteCaseRequest$domainId": "<p>A unique identifier of the Cases domain.</p>", |
619 | 644 | "DeleteCaseRuleRequest$domainId": "<p>Unique identifier of a Cases domain.</p>", |
620 | 645 | "DeleteDomainRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
621 | 646 | "DeleteFieldRequest$domainId": "<p>The unique identifier of the Cases domain.</p>", |
622 | 647 | "DeleteLayoutRequest$domainId": "<p>The unique identifier of the Cases domain.</p>", |
| 648 | + "DeleteRelatedItemRequest$domainId": "<p>A unique identifier of the Cases domain.</p>", |
623 | 649 | "DeleteTemplateRequest$domainId": "<p>The unique identifier of the Cases domain.</p>", |
624 | 650 | "DomainSummary$domainId": "<p>The unique identifier of the domain.</p>", |
625 | 651 | "GetCaseAuditEventsRequest$domainId": "<p>The unique identifier of the Cases domain.</p>", |
|
1294 | 1320 | "base": null, |
1295 | 1321 | "refs": { |
1296 | 1322 | "CreateRelatedItemResponse$relatedItemId": "<p>The unique identifier of the related item.</p>", |
| 1323 | + "DeleteRelatedItemRequest$relatedItemId": "<p>A unique identifier of a related item.</p>", |
1297 | 1324 | "SearchRelatedItemsResponseItem$relatedItemId": "<p>Unique identifier of a related item.</p>" |
1298 | 1325 | } |
1299 | 1326 | }, |
|
0 commit comments