import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateRelatedItemRequest, CreateRelatedItemResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateRelatedItemCommand}. */ export interface CreateRelatedItemCommandInput extends CreateRelatedItemRequest { } /** * @public * * The output of {@link CreateRelatedItemCommand}. */ export interface CreateRelatedItemCommandOutput extends CreateRelatedItemResponse, __MetadataBearer { } declare const CreateRelatedItemCommand_base: { new (input: CreateRelatedItemCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateRelatedItemCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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.

Use cases

Following are examples of related items that you may want to associate with a case:

Important things to know

Endpoints: See Amazon Connect endpoints and quotas.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ConnectCasesClient, CreateRelatedItemCommand } from "@aws-sdk/client-connectcases"; // ES Modules import * // const { ConnectCasesClient, CreateRelatedItemCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import * // import type { ConnectCasesClientConfig } from "@aws-sdk/client-connectcases"; * const config = {}; // type is ConnectCasesClientConfig * const client = new ConnectCasesClient(config); * const input = { // CreateRelatedItemRequest * domainId: "STRING_VALUE", // required * caseId: "STRING_VALUE", // required * type: "STRING_VALUE", // required * content: { // RelatedItemInputContent Union: only one key present * contact: { // Contact * contactArn: "STRING_VALUE", // required * }, * comment: { // CommentContent * body: "STRING_VALUE", // required * contentType: "STRING_VALUE", // required * }, * file: { // FileContent * fileArn: "STRING_VALUE", // required * }, * sla: { // SlaInputContent Union: only one key present * slaInputConfiguration: { // SlaInputConfiguration * name: "STRING_VALUE", // required * type: "STRING_VALUE", // required * fieldId: "STRING_VALUE", * targetFieldValues: [ // SlaFieldValueUnionList * { // FieldValueUnion Union: only one key present * stringValue: "STRING_VALUE", * doubleValue: Number("double"), * booleanValue: true || false, * emptyValue: {}, * userArnValue: "STRING_VALUE", * }, * ], * targetSlaMinutes: Number("long"), // required * }, * }, * connectCase: { // ConnectCaseInputContent * caseId: "STRING_VALUE", // required * }, * custom: { // CustomInputContent * fields: [ // FieldValueList // required * { // FieldValue * id: "STRING_VALUE", // required * value: {// Union: only one key present * stringValue: "STRING_VALUE", * doubleValue: Number("double"), * booleanValue: true || false, * emptyValue: {}, * userArnValue: "STRING_VALUE", * }, * }, * ], * }, * }, * performedBy: { // UserUnion Union: only one key present * userArn: "STRING_VALUE", * customEntity: "STRING_VALUE", * }, * }; * const command = new CreateRelatedItemCommand(input); * const response = await client.send(command); * // { // CreateRelatedItemResponse * // relatedItemId: "STRING_VALUE", // required * // relatedItemArn: "STRING_VALUE", // required * // }; * * ``` * * @param CreateRelatedItemCommandInput - {@link CreateRelatedItemCommandInput} * @returns {@link CreateRelatedItemCommandOutput} * @see {@link CreateRelatedItemCommandInput} for command's `input` shape. * @see {@link CreateRelatedItemCommandOutput} for command's `response` shape. * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link InternalServerException} (server fault) *

We couldn't process your request because of an issue with the server. Try again later.

* * @throws {@link ResourceNotFoundException} (client fault) *

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.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

* * @throws {@link ThrottlingException} (client fault) *

The rate has been exceeded for this API. Please try again after a few minutes.

* * @throws {@link ValidationException} (client fault) *

The request isn't valid. Check the syntax and try again.

* * @throws {@link ConnectCasesServiceException} *

Base exception class for all service exceptions from ConnectCases service.

* * * @public */ export declare class CreateRelatedItemCommand extends CreateRelatedItemCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateRelatedItemRequest; output: CreateRelatedItemResponse; }; sdk: { input: CreateRelatedItemCommandInput; output: CreateRelatedItemCommandOutput; }; }; }