Update Related Item

connectcases_update_related_item

R Documentation

Description¶

Updates the content of a related item associated with a case. The following related item types are supported:

Comment - Update the text content of an existing comment
Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas.

Important things to know

When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.
If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.
System case fields cannot be used in a custom related item.

Endpoints: See Amazon Connect endpoints and quotas.

Usage¶

connectcases_update_related_item(domainId, caseId, relatedItemId,
  content, performedBy)

Arguments¶

domainId

[required] The unique identifier of the Cases domain.

caseId

[required] A unique identifier of the case.

relatedItemId

[required] Unique identifier of a related item.

content

[required] The content of a related item to be updated.

performedBy

Represents the user who performed the update of the related item.

Value¶

A list with the following syntax:

list(
  relatedItemId = "string",
  relatedItemArn = "string",
  type = "Contact"|"Comment"|"File"|"Sla"|"ConnectCase"|"Custom",
  content = list(
    contact = list(
      contactArn = "string",
      channel = "string",
      connectedToSystemTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    comment = list(
      body = "string",
      contentType = "Text/Plain"
    ),
    file = list(
      fileArn = "string"
    ),
    sla = list(
      slaConfiguration = list(
        name = "string",
        type = "CaseField",
        status = "Active"|"Overdue"|"Met"|"NotMet",
        fieldId = "string",
        targetFieldValues = list(
          list(
            stringValue = "string",
            doubleValue = 123.0,
            booleanValue = TRUE|FALSE,
            emptyValue = list(),
            userArnValue = "string"
          )
        ),
        targetTime = as.POSIXct(
          "2015-01-01"
        ),
        completionTime = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    connectCase = list(
      caseId = "string"
    ),
    custom = list(
      fields = list(
        list(
          id = "string",
          value = list(
            stringValue = "string",
            doubleValue = 123.0,
            booleanValue = TRUE|FALSE,
            emptyValue = list(),
            userArnValue = "string"
          )
        )
      )
    )
  ),
  associationTime = as.POSIXct(
    "2015-01-01"
  ),
  tags = list(
    "string"
  ),
  lastUpdatedUser = list(
    userArn = "string",
    customEntity = "string"
  ),
  createdBy = list(
    userArn = "string",
    customEntity = "string"
  )
)

Request syntax¶

svc$update_related_item(
  domainId = "string",
  caseId = "string",
  relatedItemId = "string",
  content = list(
    comment = list(
      body = "string",
      contentType = "Text/Plain"
    ),
    custom = list(
      fields = list(
        list(
          id = "string",
          value = list(
            stringValue = "string",
            doubleValue = 123.0,
            booleanValue = TRUE|FALSE,
            emptyValue = list(),
            userArnValue = "string"
          )
        )
      )
    )
  ),
  performedBy = list(
    userArn = "string",
    customEntity = "string"
  )
)