|
11 | 11 | "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> </ul> <pre><code> </note> </code></pre>", |
12 | 12 | "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>", |
13 | 13 | "DeleteDomain": "<p>Deletes a Cases domain.</p> <pre><code> <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> </code></pre>", |
| 14 | + "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>", |
| 15 | + "DeleteLayout": "<p>Deletes a layout from a cases template. You can delete up to 100 layouts per domain.</p> <pre><code> <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> </code></pre>", |
| 16 | + "DeleteTemplate": "<p>Deletes a cases template. You can delete up to 100 templates per domain.</p> <pre><code> <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> </code></pre>", |
14 | 17 | "GetCase": "<p>Returns information about a specific case if it exists. </p>", |
15 | 18 | "GetCaseAuditEvents": "<p>Returns the audit history about a specific case if it exists.</p>", |
16 | 19 | "GetCaseEventConfiguration": "<p>Returns the case event publishing configuration.</p>", |
|
85 | 88 | } |
86 | 89 | }, |
87 | 90 | "AuditEventFieldValueUnion": { |
88 | | - "base": "<p>Object to store union of Field values.</p> <important> <p>This data type is a UNION, so only one of the following members can be specified when used or returned.</p> </important>", |
| 91 | + "base": "<p>Object to store union of Field values.</p>", |
89 | 92 | "refs": { |
90 | 93 | "AuditEventField$newValue": "<p>Union of potential field value types.</p>", |
91 | 94 | "AuditEventField$oldValue": "<p>Union of potential field value types.</p>" |
|
390 | 393 | "CreatedTime": { |
391 | 394 | "base": null, |
392 | 395 | "refs": { |
393 | | - "GetDomainResponse$createdTime": "<p>The timestamp when the Cases domain was created.</p>" |
| 396 | + "GetDomainResponse$createdTime": "<p>The timestamp when the Cases domain was created.</p>", |
| 397 | + "GetFieldResponse$createdTime": "<p>The timestamp for when the resource was created.</p>", |
| 398 | + "GetLayoutResponse$createdTime": "<p>The timestamp for when the resource was created.</p>", |
| 399 | + "GetTemplateResponse$createdTime": "<p>The timestamp for when the resource was created.</p>" |
394 | 400 | } |
395 | 401 | }, |
396 | 402 | "DeleteDomainRequest": { |
|
403 | 409 | "refs": { |
404 | 410 | } |
405 | 411 | }, |
| 412 | + "DeleteFieldRequest": { |
| 413 | + "base": null, |
| 414 | + "refs": { |
| 415 | + } |
| 416 | + }, |
| 417 | + "DeleteFieldResponse": { |
| 418 | + "base": null, |
| 419 | + "refs": { |
| 420 | + } |
| 421 | + }, |
| 422 | + "DeleteLayoutRequest": { |
| 423 | + "base": null, |
| 424 | + "refs": { |
| 425 | + } |
| 426 | + }, |
| 427 | + "DeleteLayoutResponse": { |
| 428 | + "base": null, |
| 429 | + "refs": { |
| 430 | + } |
| 431 | + }, |
| 432 | + "DeleteTemplateRequest": { |
| 433 | + "base": null, |
| 434 | + "refs": { |
| 435 | + } |
| 436 | + }, |
| 437 | + "DeleteTemplateResponse": { |
| 438 | + "base": null, |
| 439 | + "refs": { |
| 440 | + } |
| 441 | + }, |
| 442 | + "Deleted": { |
| 443 | + "base": null, |
| 444 | + "refs": { |
| 445 | + "GetFieldResponse$deleted": "<p>Indicates whether the resource has been deleted.</p>", |
| 446 | + "GetLayoutResponse$deleted": "<p>Indicates whether the resource has been deleted.</p>", |
| 447 | + "GetTemplateResponse$deleted": "<p>Indicates whether the resource has been deleted.</p>" |
| 448 | + } |
| 449 | + }, |
406 | 450 | "DomainArn": { |
407 | 451 | "base": null, |
408 | 452 | "refs": { |
|
423 | 467 | "CreateRelatedItemRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
424 | 468 | "CreateTemplateRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
425 | 469 | "DeleteDomainRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
| 470 | + "DeleteFieldRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
| 471 | + "DeleteLayoutRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
| 472 | + "DeleteTemplateRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
426 | 473 | "DomainSummary$domainId": "<p>The unique identifier of the domain.</p>", |
427 | 474 | "GetCaseAuditEventsRequest$domainId": "<p>The unique identifier of the Cases domain.</p>", |
428 | 475 | "GetCaseEventConfigurationRequest$domainId": "<p>The unique identifier of the Cases domain. </p>", |
|
550 | 597 | "refs": { |
551 | 598 | "BatchPutFieldOptionsRequest$fieldId": "<p>The unique identifier of a field.</p>", |
552 | 599 | "CreateFieldResponse$fieldId": "<p>The unique identifier of a field.</p>", |
| 600 | + "DeleteFieldRequest$fieldId": "<p>The unique identifier of a field.</p>", |
553 | 601 | "FieldError$id": "<p>The field identifier that caused the error.</p>", |
554 | 602 | "FieldIdentifier$id": "<p>Unique identifier of a field.</p>", |
555 | 603 | "FieldItem$id": "<p>Unique identifier of a field.</p>", |
|
773 | 821 | "refs": { |
774 | 822 | } |
775 | 823 | }, |
| 824 | + "LastModifiedTime": { |
| 825 | + "base": null, |
| 826 | + "refs": { |
| 827 | + "GetFieldResponse$lastModifiedTime": "<p>The timestamp for when the resource was created or last modified.</p>", |
| 828 | + "GetLayoutResponse$lastModifiedTime": "<p>The timestamp for when the resource was created or last modified.</p>", |
| 829 | + "GetTemplateResponse$lastModifiedTime": "<p>The timestamp for when the resource was created or last modified.</p>" |
| 830 | + } |
| 831 | + }, |
776 | 832 | "LayoutArn": { |
777 | 833 | "base": null, |
778 | 834 | "refs": { |
|
801 | 857 | "base": null, |
802 | 858 | "refs": { |
803 | 859 | "CreateLayoutResponse$layoutId": "<p>The unique identifier of the layout.</p>", |
| 860 | + "DeleteLayoutRequest$layoutId": "<p>The unique identifier of the layout.</p>", |
804 | 861 | "GetLayoutRequest$layoutId": "<p>The unique identifier of the layout.</p>", |
805 | 862 | "GetLayoutResponse$layoutId": "<p>The unique identifier of the layout.</p>", |
806 | 863 | "LayoutConfiguration$defaultLayout": "<p> Unique identifier of a layout. </p>", |
|
1234 | 1291 | "CaseSummary$templateId": "<p>A unique identifier of a template.</p>", |
1235 | 1292 | "CreateCaseRequest$templateId": "<p>A unique identifier of a template.</p>", |
1236 | 1293 | "CreateTemplateResponse$templateId": "<p>A unique identifier of a template.</p>", |
| 1294 | + "DeleteTemplateRequest$templateId": "<p>A unique identifier of a template.</p>", |
1237 | 1295 | "GetCaseResponse$templateId": "<p>A unique identifier of a template.</p>", |
1238 | 1296 | "GetTemplateRequest$templateId": "<p>A unique identifier of a template.</p>", |
1239 | 1297 | "GetTemplateResponse$templateId": "<p>A unique identifier of a template.</p>", |
|
0 commit comments