GetConfigurationSetEventDestinationsCommand

Suggest an Edit
Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

Example Syntax

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

import { PinpointSMSVoiceClient, GetConfigurationSetEventDestinationsCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import
// const { PinpointSMSVoiceClient, GetConfigurationSetEventDestinationsCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import
const client = new PinpointSMSVoiceClient(config);
const input = { // GetConfigurationSetEventDestinationsRequest
  ConfigurationSetName: "STRING_VALUE", // required
};
const command = new GetConfigurationSetEventDestinationsCommand(input);
const response = await client.send(command);
// { // GetConfigurationSetEventDestinationsResponse
//   EventDestinations: [ // EventDestinations
//     { // EventDestination
//       CloudWatchLogsDestination: { // CloudWatchLogsDestination
//         IamRoleArn: "STRING_VALUE",
//         LogGroupArn: "STRING_VALUE",
//       },
//       Enabled: true || false,
//       KinesisFirehoseDestination: { // KinesisFirehoseDestination
//         DeliveryStreamArn: "STRING_VALUE",
//         IamRoleArn: "STRING_VALUE",
//       },
//       MatchingEventTypes: [ // EventTypes
//         "INITIATED_CALL" || "RINGING" || "ANSWERED" || "COMPLETED_CALL" || "BUSY" || "FAILED" || "NO_ANSWER",
//       ],
//       Name: "STRING_VALUE",
//       SnsDestination: { // SnsDestination
//         TopicArn: "STRING_VALUE",
//       },
//     },
//   ],
// };

GetConfigurationSetEventDestinationsCommand Input

See GetConfigurationSetEventDestinationsCommandInput for more details

Parameter
Type
Description
ConfigurationSetName
Required
string | undefined
ConfigurationSetName

GetConfigurationSetEventDestinationsCommand Output

See GetConfigurationSetEventDestinationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EventDestinations
EventDestination[] | undefined
An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.

Throws

Name
Fault
Details
BadRequestException
client
The input you provided is invalid.
InternalServiceErrorException
server
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
NotFoundException
client
The resource you attempted to access doesn't exist.
TooManyRequestsException
client
You've issued too many requests to the resource. Wait a few minutes, and then try again.
PinpointSMSVoiceServiceException
Base exception class for all service exceptions from PinpointSMSVoice service.