GetVoiceConnectorStreamingConfigurationCommand

Suggest an Edit

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Example Syntax

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

import { ChimeSDKVoiceClient, GetVoiceConnectorStreamingConfigurationCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, GetVoiceConnectorStreamingConfigurationCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // GetVoiceConnectorStreamingConfigurationRequest
  VoiceConnectorId: "STRING_VALUE", // required
};
const command = new GetVoiceConnectorStreamingConfigurationCommand(input);
const response = await client.send(command);
// { // GetVoiceConnectorStreamingConfigurationResponse
//   StreamingConfiguration: { // StreamingConfiguration
//     DataRetentionInHours: Number("int"), // required
//     Disabled: true || false, // required
//     StreamingNotificationTargets: [ // StreamingNotificationTargetList
//       { // StreamingNotificationTarget
//         NotificationTarget: "EventBridge" || "SNS" || "SQS",
//       },
//     ],
//     MediaInsightsConfiguration: { // MediaInsightsConfiguration
//       Disabled: true || false,
//       ConfigurationArn: "STRING_VALUE",
//     },
//   },
// };

GetVoiceConnectorStreamingConfigurationCommand Input

See GetVoiceConnectorStreamingConfigurationCommandInput for more details

Parameter
Type
Description
VoiceConnectorId
Required
string | undefined

The Voice Connector ID.

GetVoiceConnectorStreamingConfigurationCommand Output

See GetVoiceConnectorStreamingConfigurationCommandOutput for details

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

The details of the streaming configuration.

Throws

Name
Fault
Details
BadRequestException
client

The input parameters don't match the service's restrictions.

ForbiddenException
client

The client is permanently forbidden from making the request.

NotFoundException
client

The requested resource couldn't be found.

ServiceFailureException
server

The service encountered an unexpected error.

ServiceUnavailableException
server

The service is currently unavailable.

ThrottledClientException
client

The number of customer requests exceeds the request rate limit.

UnauthorizedClientException
client

The client isn't authorized to request a resource.

ChimeSDKVoiceServiceException
Base exception class for all service exceptions from ChimeSDKVoice service.