- 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.
DescribePromptCommand
Describes the prompt.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, DescribePromptCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribePromptCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribePromptRequest
InstanceId: "STRING_VALUE", // required
PromptId: "STRING_VALUE", // required
};
const command = new DescribePromptCommand(input);
const response = await client.send(command);
// { // DescribePromptResponse
// Prompt: { // Prompt
// PromptARN: "STRING_VALUE",
// PromptId: "STRING_VALUE",
// Name: "STRING_VALUE",
// Description: "STRING_VALUE",
// Tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// LastModifiedTime: new Date("TIMESTAMP"),
// LastModifiedRegion: "STRING_VALUE",
// },
// };
DescribePromptCommand Input
See DescribePromptCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
PromptIdRequired | string | undefined | A unique identifier for the prompt. |
DescribePromptCommand Output
See DescribePromptCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Prompt | Prompt | undefined | Information about the prompt. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | client | One or more of the specified parameters are not valid. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |