|
170 | 170 | {"shape":"ConflictException"}, |
171 | 171 | {"shape":"ServiceQuotaExceededException"} |
172 | 172 | ], |
173 | | - "documentation":"<p>Creates a template in the Cases domain. This template is used to define the case object model (that is, 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.</p>", |
| 173 | + "documentation":"<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>", |
174 | 174 | "idempotent":true |
175 | 175 | }, |
176 | 176 | "GetCase":{ |
|
532 | 532 | {"shape":"ValidationException"}, |
533 | 533 | {"shape":"ThrottlingException"}, |
534 | 534 | {"shape":"AccessDeniedException"}, |
535 | | - {"shape":"ConflictException"} |
| 535 | + {"shape":"ConflictException"}, |
| 536 | + {"shape":"ServiceQuotaExceededException"} |
536 | 537 | ], |
537 | 538 | "documentation":"<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>", |
538 | 539 | "idempotent":true |
|
554 | 555 | {"shape":"AccessDeniedException"}, |
555 | 556 | {"shape":"ConflictException"} |
556 | 557 | ], |
557 | | - "documentation":"<p>Updates the attributes of an existing template. The template attributes that can be modified include <code>name</code>, <code>description</code>, <code>layouts</code>, and <code>requiredFields</code>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.</p>", |
| 558 | + "documentation":"<p>Updates the attributes of an existing template. The template attributes that can be modified include <code>name</code>, <code>description</code>, <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.</p>", |
558 | 559 | "idempotent":true |
559 | 560 | } |
560 | 561 | }, |
|
891 | 892 | "members":{ |
892 | 893 | "clientToken":{ |
893 | 894 | "shape":"CreateCaseRequestClientTokenString", |
894 | | - "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", |
| 895 | + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", |
895 | 896 | "idempotencyToken":true |
896 | 897 | }, |
897 | 898 | "domainId":{ |
|
1132 | 1133 | "requiredFields":{ |
1133 | 1134 | "shape":"RequiredFieldList", |
1134 | 1135 | "documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>" |
| 1136 | + }, |
| 1137 | + "status":{ |
| 1138 | + "shape":"TemplateStatus", |
| 1139 | + "documentation":"<p>The status of the template.</p>" |
1135 | 1140 | } |
1136 | 1141 | } |
1137 | 1142 | }, |
|
1321 | 1326 | "FieldGroupFieldsList":{ |
1322 | 1327 | "type":"list", |
1323 | 1328 | "member":{"shape":"FieldItem"}, |
1324 | | - "max":30, |
| 1329 | + "max":100, |
1325 | 1330 | "min":0 |
1326 | 1331 | }, |
1327 | 1332 | "FieldGroupNameString":{ |
|
1771 | 1776 | "type":"structure", |
1772 | 1777 | "required":[ |
1773 | 1778 | "name", |
| 1779 | + "status", |
1774 | 1780 | "templateArn", |
1775 | 1781 | "templateId" |
1776 | 1782 | ], |
|
1791 | 1797 | "shape":"RequiredFieldList", |
1792 | 1798 | "documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>" |
1793 | 1799 | }, |
| 1800 | + "status":{ |
| 1801 | + "shape":"TemplateStatus", |
| 1802 | + "documentation":"<p>The status of the template.</p>" |
| 1803 | + }, |
1794 | 1804 | "tags":{ |
1795 | 1805 | "shape":"Tags", |
1796 | 1806 | "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>" |
|
2165 | 2175 | "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>", |
2166 | 2176 | "location":"querystring", |
2167 | 2177 | "locationName":"nextToken" |
| 2178 | + }, |
| 2179 | + "status":{ |
| 2180 | + "shape":"TemplateStatusFilters", |
| 2181 | + "documentation":"<p>A list of status values to filter on.</p>", |
| 2182 | + "location":"querystring", |
| 2183 | + "locationName":"status" |
2168 | 2184 | } |
2169 | 2185 | } |
2170 | 2186 | }, |
|
2662 | 2678 | "min":1, |
2663 | 2679 | "pattern":"^.*[\\S]$" |
2664 | 2680 | }, |
| 2681 | + "TemplateStatus":{ |
| 2682 | + "type":"string", |
| 2683 | + "documentation":"<p>Status of a template</p>", |
| 2684 | + "enum":[ |
| 2685 | + "Active", |
| 2686 | + "Inactive" |
| 2687 | + ] |
| 2688 | + }, |
| 2689 | + "TemplateStatusFilters":{ |
| 2690 | + "type":"list", |
| 2691 | + "member":{"shape":"TemplateStatus"}, |
| 2692 | + "documentation":"<p>List of filters used on the ListTemplates result set</p>", |
| 2693 | + "max":2, |
| 2694 | + "min":1 |
| 2695 | + }, |
2665 | 2696 | "TemplateSummary":{ |
2666 | 2697 | "type":"structure", |
2667 | 2698 | "required":[ |
2668 | 2699 | "name", |
| 2700 | + "status", |
2669 | 2701 | "templateArn", |
2670 | 2702 | "templateId" |
2671 | 2703 | ], |
|
2674 | 2706 | "shape":"TemplateName", |
2675 | 2707 | "documentation":"<p>The template name.</p>" |
2676 | 2708 | }, |
| 2709 | + "status":{ |
| 2710 | + "shape":"TemplateStatus", |
| 2711 | + "documentation":"<p>The status of the template.</p>" |
| 2712 | + }, |
2677 | 2713 | "templateArn":{ |
2678 | 2714 | "shape":"TemplateArn", |
2679 | 2715 | "documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>" |
|
2854 | 2890 | "shape":"RequiredFieldList", |
2855 | 2891 | "documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>" |
2856 | 2892 | }, |
| 2893 | + "status":{ |
| 2894 | + "shape":"TemplateStatus", |
| 2895 | + "documentation":"<p>The status of the template.</p>" |
| 2896 | + }, |
2857 | 2897 | "templateId":{ |
2858 | 2898 | "shape":"TemplateId", |
2859 | 2899 | "documentation":"<p>A unique identifier for the template.</p>", |
|
0 commit comments