You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// Performs the `CreateRelatedItem` operation on the `ConnectCases` service.
971
971
///
972
-
/// Creates a related item (comments, tasks, and contacts) and associates it with a case.
972
+
/// Creates a related item (comments, tasks, and contacts) and associates it with a case. There's a quota for the number of fields allowed in a Custom type related item. See [Amazon Connect Cases quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#cases-quotas). Use cases Following are examples of related items that you may want to associate with a case:
973
+
///
974
+
/// * Related contacts, such as calls, chats, emails tasks
975
+
///
976
+
/// * Comments, for agent notes
977
+
///
978
+
/// * SLAs, to capture target resolution goals
979
+
///
980
+
/// * Cases, to capture related Amazon Connect Cases
981
+
///
982
+
/// * Files, such as policy documentation or customer-provided attachments
983
+
///
984
+
/// * Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more
985
+
///
986
+
///
987
+
/// Important things to know
988
+
///
989
+
/// * If you are associating a contact to a case by passing in Contact for a type, you must have [DescribeContact](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeContact.html) permission on the ARN of the contact that you provide in content.contact.contactArn.
973
990
///
974
991
/// * 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 contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.
975
992
///
976
993
/// * If you provide a value for performedBy.userArn you must also have [DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the ARN of the user that you provide.
977
994
///
978
995
/// * The type field is reserved for internal use only.
979
996
///
997
+
///
998
+
/// Endpoints: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).
/// * Deleted fields are not included in the ListFields response.
1357
1377
///
1358
-
/// * Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted.
1378
+
/// * Calling CreateCase with a deleted field throws a ValidationException denoting which field identifiers in the request have been deleted.
1359
1379
///
1360
-
/// * Calling GetCase with a deleted field ID returns the deleted field's value if one exists.
1380
+
/// * Calling GetCase with a deleted field identifier returns the deleted field's value if one exists.
1361
1381
///
1362
1382
/// * Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case.
/// * This API returns case IDs, not complete case objects. To retrieve full case details, you must make additional calls to the [GetCase](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html) API for each returned case ID.
2768
+
/// * This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the [GetCase](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html) API for each returned case ID.
2749
2769
///
2750
2770
/// * This API searches across related items content, not case fields. Use the [SearchCases](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html) API to search within case field values.
/// - `ConflictException` : The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
3194
3214
/// - `InternalServerException` : We couldn't process your request because of an issue with the server. Try again later.
3195
3215
/// - `ResourceNotFoundException` : We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
3216
+
/// - `ServiceQuotaExceededException` : The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide.
3196
3217
/// - `ThrottlingException` : The rate has been exceeded for this API. Please try again after a few minutes.
3197
3218
/// - `ValidationException` : The request isn't valid. Check the syntax and try again.
/// - `ConflictException` : The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
3422
3443
/// - `InternalServerException` : We couldn't process your request because of an issue with the server. Try again later.
3423
3444
/// - `ResourceNotFoundException` : We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
3445
+
/// - `ServiceQuotaExceededException` : The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the Amazon Connect Administrator Guide.
3424
3446
/// - `ThrottlingException` : The rate has been exceeded for this API. Please try again after a few minutes.
3425
3447
/// - `ValidationException` : The request isn't valid. Check the syntax and try again.
0 commit comments