- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
PutSipMediaApplicationAlexaSkillConfigurationCommand
- Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties).
Updates the Alexa Skill configuration for the SIP media application.
Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ChimeSDKVoiceClient, PutSipMediaApplicationAlexaSkillConfigurationCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, PutSipMediaApplicationAlexaSkillConfigurationCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // PutSipMediaApplicationAlexaSkillConfigurationRequest
SipMediaApplicationId: "STRING_VALUE", // required
SipMediaApplicationAlexaSkillConfiguration: { // SipMediaApplicationAlexaSkillConfiguration
AlexaSkillStatus: "ACTIVE" || "INACTIVE", // required
AlexaSkillIds: [ // AlexaSkillIdList // required
"STRING_VALUE",
],
},
};
const command = new PutSipMediaApplicationAlexaSkillConfigurationCommand(input);
const response = await client.send(command);
// { // PutSipMediaApplicationAlexaSkillConfigurationResponse
// SipMediaApplicationAlexaSkillConfiguration: { // SipMediaApplicationAlexaSkillConfiguration
// AlexaSkillStatus: "ACTIVE" || "INACTIVE", // required
// AlexaSkillIds: [ // AlexaSkillIdList // required
// "STRING_VALUE",
// ],
// },
// };
PutSipMediaApplicationAlexaSkillConfigurationCommand Input
See PutSipMediaApplicationAlexaSkillConfigurationCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
SipMediaApplicationIdRequired | string | undefined | The SIP media application ID. |
SipMediaApplicationAlexaSkillConfiguration | SipMediaApplicationAlexaSkillConfiguration | undefined | The Alexa Skill configuration. |
PutSipMediaApplicationAlexaSkillConfigurationCommand Output
See PutSipMediaApplicationAlexaSkillConfigurationCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
SipMediaApplicationAlexaSkillConfiguration | SipMediaApplicationAlexaSkillConfiguration | undefined | Returns the Alexa Skill configuration. |
Throws
Name | Fault | Details |
|---|
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. |