|
622 | 622 | ], |
623 | 623 | "documentation":"<p>Adds case event publishing configuration. For a complete list of fields you can add to the event message, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html\">Create case fields</a> in the <i>Amazon Connect Administrator Guide</i> </p>" |
624 | 624 | }, |
| 625 | + "SearchAllRelatedItems":{ |
| 626 | + "name":"SearchAllRelatedItems", |
| 627 | + "http":{ |
| 628 | + "method":"POST", |
| 629 | + "requestUri":"/domains/{domainId}/related-items-search", |
| 630 | + "responseCode":200 |
| 631 | + }, |
| 632 | + "input":{"shape":"SearchAllRelatedItemsRequest"}, |
| 633 | + "output":{"shape":"SearchAllRelatedItemsResponse"}, |
| 634 | + "errors":[ |
| 635 | + {"shape":"InternalServerException"}, |
| 636 | + {"shape":"ResourceNotFoundException"}, |
| 637 | + {"shape":"ValidationException"}, |
| 638 | + {"shape":"ThrottlingException"}, |
| 639 | + {"shape":"AccessDeniedException"} |
| 640 | + ], |
| 641 | + "documentation":"<p>Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItems.html\">SearchRelatedItems</a> API.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Find cases with similar issues across the domain. For example, search for all cases containing comments about \"product defect\" to identify patterns and existing solutions.</p> </li> <li> <p>Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. </p> </li> <li> <p>Monitor SLA compliance across cases. For example, search for all cases with \"Active\" SLA status to prioritize remediation efforts.</p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>This API returns case IDs, not complete case objects. To retrieve full case details, you must make additional calls to the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html\">GetCase</a> API for each returned case ID. </p> </li> <li> <p>This API searches across related items content, not case fields. Use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html\">SearchCases</a> API to search within case field values.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>" |
| 642 | + }, |
625 | 643 | "SearchCases":{ |
626 | 644 | "name":"SearchCases", |
627 | 645 | "http":{ |
|
1390 | 1408 | "members":{ |
1391 | 1409 | "caseId":{ |
1392 | 1410 | "shape":"CaseId", |
1393 | | - "documentation":"<p>The unique identifier of the related case</p>" |
| 1411 | + "documentation":"<p>A unique identifier of the case.</p>" |
1394 | 1412 | } |
1395 | 1413 | }, |
1396 | | - "documentation":"<p>Represents the content of a Case related item</p>" |
| 1414 | + "documentation":"<p>Represents the content of a <code>ConnectCase</code> type related item.</p>" |
1397 | 1415 | }, |
1398 | 1416 | "ConnectCaseFilter":{ |
1399 | 1417 | "type":"structure", |
1400 | 1418 | "members":{ |
1401 | 1419 | "caseId":{ |
1402 | 1420 | "shape":"CaseId", |
1403 | | - "documentation":"<p>The unique identifier of the case to filter by</p>" |
| 1421 | + "documentation":"<p>A unique identifier of the case.</p>" |
1404 | 1422 | } |
1405 | 1423 | }, |
1406 | | - "documentation":"<p>A filter for related items of type Case</p>" |
| 1424 | + "documentation":"<p>A filter for related items of type <code>ConnectCase</code>.</p>" |
1407 | 1425 | }, |
1408 | 1426 | "ConnectCaseInputContent":{ |
1409 | 1427 | "type":"structure", |
1410 | 1428 | "required":["caseId"], |
1411 | 1429 | "members":{ |
1412 | 1430 | "caseId":{ |
1413 | 1431 | "shape":"CaseId", |
1414 | | - "documentation":"<p>The unique identifier of the case to be related</p>" |
| 1432 | + "documentation":"<p>A unique identifier of the case.</p>" |
1415 | 1433 | } |
1416 | 1434 | }, |
1417 | | - "documentation":"<p>Represents the input content of a Case related item</p>" |
| 1435 | + "documentation":"<p>Represents the content of a <code>ConnectCase</code> related item.</p>" |
1418 | 1436 | }, |
1419 | 1437 | "ConnectedToSystemTime":{ |
1420 | 1438 | "type":"timestamp", |
|
1818 | 1836 | "members":{ |
1819 | 1837 | "fields":{ |
1820 | 1838 | "shape":"FieldValueList", |
1821 | | - "documentation":"<p>List of field values for the custom related item</p>" |
| 1839 | + "documentation":"<p>List of field values for the <code>Custom</code> related item.</p>" |
1822 | 1840 | } |
1823 | 1841 | }, |
1824 | | - "documentation":"<p>Represents the content of a Custom related item</p>" |
| 1842 | + "documentation":"<p>Represents the content of a <code>Custom</code> type related item.</p>" |
1825 | 1843 | }, |
1826 | 1844 | "CustomEntity":{ |
1827 | 1845 | "type":"string", |
|
1836 | 1854 | "field":{"shape":"FieldFilter"}, |
1837 | 1855 | "not":{ |
1838 | 1856 | "shape":"CustomFieldsFilter", |
1839 | | - "documentation":"<p>Excludes items matching the filter</p>" |
| 1857 | + "documentation":"<p>Excludes items matching the filter.</p>" |
1840 | 1858 | }, |
1841 | 1859 | "andAll":{ |
1842 | 1860 | "shape":"CustomFieldsFilterAndAllList", |
1843 | | - "documentation":"<p>Matches items that satisfy all of the specified filter conditions</p>" |
| 1861 | + "documentation":"<p>Provides \"and all\" filtering.</p>" |
1844 | 1862 | }, |
1845 | 1863 | "orAll":{ |
1846 | 1864 | "shape":"CustomFieldsFilterOrAllList", |
1847 | | - "documentation":"<p>Matches items that satisfy any of the specified filter conditions</p>" |
| 1865 | + "documentation":"<p>Provides \"or all\" filtering.</p>" |
1848 | 1866 | } |
1849 | 1867 | }, |
1850 | | - "documentation":"<p>A filter for fields in related items of type Custom</p>", |
| 1868 | + "documentation":"<p>A filter for fields in <code>Custom</code> type related items. Only one value can be provided.</p>", |
1851 | 1869 | "union":true |
1852 | 1870 | }, |
1853 | 1871 | "CustomFieldsFilterAndAllList":{ |
|
1867 | 1885 | "members":{ |
1868 | 1886 | "fields":{ |
1869 | 1887 | "shape":"CustomFieldsFilter", |
1870 | | - "documentation":"<p>Filter conditions for custom fields</p>" |
| 1888 | + "documentation":"<p>Filter conditions for custom fields.</p>" |
1871 | 1889 | } |
1872 | 1890 | }, |
1873 | | - "documentation":"<p>A filter for related items of type Custom</p>" |
| 1891 | + "documentation":"<p>A filter for related items of type <code>Custom</code>.</p>" |
1874 | 1892 | }, |
1875 | 1893 | "CustomInputContent":{ |
1876 | 1894 | "type":"structure", |
1877 | 1895 | "required":["fields"], |
1878 | 1896 | "members":{ |
1879 | 1897 | "fields":{ |
1880 | 1898 | "shape":"CustomInputContentFieldsList", |
1881 | | - "documentation":"<p>List of field values for the custom related item</p>" |
| 1899 | + "documentation":"<p>List of field values for the <code>Custom</code> related item.</p>" |
1882 | 1900 | } |
1883 | 1901 | }, |
1884 | | - "documentation":"<p>Represents the input content of a Custom related item</p>" |
| 1902 | + "documentation":"<p>Represents the content of a <code>Custom</code> related item.</p>" |
1885 | 1903 | }, |
1886 | 1904 | "CustomInputContentFieldsList":{ |
1887 | 1905 | "type":"list", |
|
3468 | 3486 | }, |
3469 | 3487 | "connectCase":{ |
3470 | 3488 | "shape":"ConnectCaseContent", |
3471 | | - "documentation":"<p>Content for a related Connect case</p>" |
| 3489 | + "documentation":"<p>Represents the Amazon Connect case to be created as a related item.</p>" |
3472 | 3490 | }, |
3473 | 3491 | "custom":{ |
3474 | 3492 | "shape":"CustomContent", |
3475 | | - "documentation":"<p>Content for a custom related item</p>" |
| 3493 | + "documentation":"<p>Represents the content of a <code>Custom</code> type related item.</p>" |
3476 | 3494 | } |
3477 | 3495 | }, |
3478 | 3496 | "documentation":"<p>Represents the content of a particular type of related item.</p>", |
|
3515 | 3533 | }, |
3516 | 3534 | "connectCase":{ |
3517 | 3535 | "shape":"ConnectCaseInputContent", |
3518 | | - "documentation":"<p>Input content for a related Connect case</p>" |
| 3536 | + "documentation":"<p>Represents the Amazon Connect case to be created as a related item.</p>" |
3519 | 3537 | }, |
3520 | 3538 | "custom":{ |
3521 | 3539 | "shape":"CustomInputContent", |
3522 | | - "documentation":"<p>Input content for a custom related item</p>" |
| 3540 | + "documentation":"<p>Represents the content of a <code>Custom</code> type related item.</p>" |
3523 | 3541 | } |
3524 | 3542 | }, |
3525 | 3543 | "documentation":"<p>Represents the content of a related item to be created.</p>", |
|
3557 | 3575 | }, |
3558 | 3576 | "connectCase":{ |
3559 | 3577 | "shape":"ConnectCaseFilter", |
3560 | | - "documentation":"<p>Filter for related items of type Connect case</p>" |
| 3578 | + "documentation":"<p>Represents the Amazon Connect case to be created as a related item.</p>" |
3561 | 3579 | }, |
3562 | 3580 | "custom":{ |
3563 | 3581 | "shape":"CustomFilter", |
3564 | | - "documentation":"<p>Filter for related items of type Custom</p>" |
| 3582 | + "documentation":"<p>Represents the content of a <code>Custom</code> type related item.</p>" |
3565 | 3583 | } |
3566 | 3584 | }, |
3567 | 3585 | "documentation":"<p>The list of types of related items and their parameters to use for filtering.</p>", |
|
3631 | 3649 | "type":"string", |
3632 | 3650 | "enum":["Required"] |
3633 | 3651 | }, |
| 3652 | + "SearchAllRelatedItemsRequest":{ |
| 3653 | + "type":"structure", |
| 3654 | + "required":["domainId"], |
| 3655 | + "members":{ |
| 3656 | + "domainId":{ |
| 3657 | + "shape":"DomainId", |
| 3658 | + "documentation":"<p>The unique identifier of the Cases domain. </p>", |
| 3659 | + "location":"uri", |
| 3660 | + "locationName":"domainId" |
| 3661 | + }, |
| 3662 | + "maxResults":{ |
| 3663 | + "shape":"SearchAllRelatedItemsRequestMaxResultsInteger", |
| 3664 | + "documentation":"<p>The maximum number of results to return per page.</p>" |
| 3665 | + }, |
| 3666 | + "nextToken":{ |
| 3667 | + "shape":"NextToken", |
| 3668 | + "documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>" |
| 3669 | + }, |
| 3670 | + "filters":{ |
| 3671 | + "shape":"SearchAllRelatedItemsRequestFiltersList", |
| 3672 | + "documentation":"<p>The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.</p>" |
| 3673 | + }, |
| 3674 | + "sorts":{ |
| 3675 | + "shape":"SearchAllRelatedItemsRequestSortsList", |
| 3676 | + "documentation":"<p>A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.</p>" |
| 3677 | + } |
| 3678 | + } |
| 3679 | + }, |
| 3680 | + "SearchAllRelatedItemsRequestFiltersList":{ |
| 3681 | + "type":"list", |
| 3682 | + "member":{"shape":"RelatedItemTypeFilter"}, |
| 3683 | + "max":10, |
| 3684 | + "min":0 |
| 3685 | + }, |
| 3686 | + "SearchAllRelatedItemsRequestMaxResultsInteger":{ |
| 3687 | + "type":"integer", |
| 3688 | + "box":true, |
| 3689 | + "max":25, |
| 3690 | + "min":1 |
| 3691 | + }, |
| 3692 | + "SearchAllRelatedItemsRequestSortsList":{ |
| 3693 | + "type":"list", |
| 3694 | + "member":{"shape":"SearchAllRelatedItemsSort"}, |
| 3695 | + "max":2, |
| 3696 | + "min":0 |
| 3697 | + }, |
| 3698 | + "SearchAllRelatedItemsResponse":{ |
| 3699 | + "type":"structure", |
| 3700 | + "required":["relatedItems"], |
| 3701 | + "members":{ |
| 3702 | + "nextToken":{ |
| 3703 | + "shape":"NextToken", |
| 3704 | + "documentation":"<p>The token for the next set of results. This is null if there are no more results to return.</p>" |
| 3705 | + }, |
| 3706 | + "relatedItems":{ |
| 3707 | + "shape":"SearchAllRelatedItemsResponseRelatedItemsList", |
| 3708 | + "documentation":"<p>A list of items related to a case.</p>" |
| 3709 | + } |
| 3710 | + } |
| 3711 | + }, |
| 3712 | + "SearchAllRelatedItemsResponseItem":{ |
| 3713 | + "type":"structure", |
| 3714 | + "required":[ |
| 3715 | + "relatedItemId", |
| 3716 | + "caseId", |
| 3717 | + "type", |
| 3718 | + "associationTime", |
| 3719 | + "content" |
| 3720 | + ], |
| 3721 | + "members":{ |
| 3722 | + "relatedItemId":{ |
| 3723 | + "shape":"RelatedItemId", |
| 3724 | + "documentation":"<p>Unique identifier of a related item.</p>" |
| 3725 | + }, |
| 3726 | + "caseId":{ |
| 3727 | + "shape":"CaseId", |
| 3728 | + "documentation":"<p>A unique identifier of the case.</p>" |
| 3729 | + }, |
| 3730 | + "type":{ |
| 3731 | + "shape":"RelatedItemType", |
| 3732 | + "documentation":"<p>Type of a related item.</p>" |
| 3733 | + }, |
| 3734 | + "associationTime":{ |
| 3735 | + "shape":"AssociationTime", |
| 3736 | + "documentation":"<p>Time at which a related item was associated with a case.</p>" |
| 3737 | + }, |
| 3738 | + "content":{"shape":"RelatedItemContent"}, |
| 3739 | + "performedBy":{"shape":"UserUnion"}, |
| 3740 | + "tags":{ |
| 3741 | + "shape":"Tags", |
| 3742 | + "documentation":"<p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>" |
| 3743 | + } |
| 3744 | + }, |
| 3745 | + "documentation":"<p>A list of items that represent RelatedItems. This data type is similar to <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItemsResponseItem.html\">SearchRelatedItemsResponseItem</a> except Search<b>All</b>RelatedItemsResponseItem has a caseId field.</p>" |
| 3746 | + }, |
| 3747 | + "SearchAllRelatedItemsResponseRelatedItemsList":{ |
| 3748 | + "type":"list", |
| 3749 | + "member":{"shape":"SearchAllRelatedItemsResponseItem"}, |
| 3750 | + "max":25, |
| 3751 | + "min":0 |
| 3752 | + }, |
| 3753 | + "SearchAllRelatedItemsSort":{ |
| 3754 | + "type":"structure", |
| 3755 | + "required":[ |
| 3756 | + "sortProperty", |
| 3757 | + "sortOrder" |
| 3758 | + ], |
| 3759 | + "members":{ |
| 3760 | + "sortProperty":{ |
| 3761 | + "shape":"SearchAllRelatedItemsSortProperty", |
| 3762 | + "documentation":"<p>Whether related items should be sorted in ascending or descending order. </p>" |
| 3763 | + }, |
| 3764 | + "sortOrder":{ |
| 3765 | + "shape":"Order", |
| 3766 | + "documentation":"<p>Whether related items should be sorted by association time or case ID. </p>" |
| 3767 | + } |
| 3768 | + }, |
| 3769 | + "documentation":"<p>The order in which all returned related items should be sorted.</p>" |
| 3770 | + }, |
| 3771 | + "SearchAllRelatedItemsSortProperty":{ |
| 3772 | + "type":"string", |
| 3773 | + "enum":[ |
| 3774 | + "AssociationTime", |
| 3775 | + "CaseId" |
| 3776 | + ] |
| 3777 | + }, |
3634 | 3778 | "SearchCasesRequest":{ |
3635 | 3779 | "type":"structure", |
3636 | 3780 | "required":["domainId"], |
|
0 commit comments