|
8 | 8 | "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> <pre><code> </important> </code></pre>",
|
9 | 9 | "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>",
|
10 | 10 | "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>",
|
11 |
| - "CreateRelatedItem": "<p>Creates a related item (comments, tasks, and contacts) and associates it with a case.</p> <note> <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> </note>", |
| 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 | 14 | "GetCase": "<p>Returns information about a specific case if it exists. </p>",
|
|
1229 | 1229 | "refs": {
|
1230 | 1230 | }
|
1231 | 1231 | },
|
| 1232 | + "UserArn": { |
| 1233 | + "base": null, |
| 1234 | + "refs": { |
| 1235 | + "UserUnion$userArn": "<p>Represents the Amazon Connect ARN of the user.</p>" |
| 1236 | + } |
| 1237 | + }, |
| 1238 | + "UserUnion": { |
| 1239 | + "base": "<p>Represents the identity of the person who performed the action.</p>", |
| 1240 | + "refs": { |
| 1241 | + "CreateRelatedItemRequest$performedBy": "<p>Represents the creator of the related item.</p>", |
| 1242 | + "SearchRelatedItemsResponseItem$performedBy": "<p>Represents the creator of the related item.</p>" |
| 1243 | + } |
| 1244 | + }, |
1232 | 1245 | "ValidationException": {
|
1233 | 1246 | "base": "<p>The request isn't valid. Check the syntax and try again.</p>",
|
1234 | 1247 | "refs": {
|
|
0 commit comments