GetCaseEventConfigurationCommand

Suggest an Edit

Returns the case event publishing configuration.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectCasesClient, GetCaseEventConfigurationCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
// const { ConnectCasesClient, GetCaseEventConfigurationCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
const client = new ConnectCasesClient(config);
const input = { // GetCaseEventConfigurationRequest
  domainId: "STRING_VALUE", // required
};
const command = new GetCaseEventConfigurationCommand(input);
const response = await client.send(command);
// { // GetCaseEventConfigurationResponse
//   eventBridge: { // EventBridgeConfiguration
//     enabled: true || false, // required
//     includedData: { // EventIncludedData
//       caseData: { // CaseEventIncludedData
//         fields: [ // FieldIdentifierList // required
//           { // FieldIdentifier
//             id: "STRING_VALUE", // required
//           },
//         ],
//       },
//       relatedItemData: { // RelatedItemEventIncludedData
//         includeContent: true || false, // required
//       },
//     },
//   },
// };

GetCaseEventConfigurationCommand Input

See GetCaseEventConfigurationCommandInput for more details

Parameter
Type
Description
domainId
Required
string | undefined

The unique identifier of the Cases domain.

GetCaseEventConfigurationCommand Output

See GetCaseEventConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
eventBridge
Required
EventBridgeConfiguration | undefined

Configuration to enable EventBridge case event delivery and determine what data is delivered.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

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.

ThrottlingException
client

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

ValidationException
client

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

ConnectCasesServiceException
Base exception class for all service exceptions from ConnectCases service.