- 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.
GetPromptFileCommand
Gets the prompt file.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, GetPromptFileCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, GetPromptFileCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // GetPromptFileRequest
InstanceId: "STRING_VALUE", // required
PromptId: "STRING_VALUE", // required
};
const command = new GetPromptFileCommand(input);
const response = await client.send(command);
// { // GetPromptFileResponse
// PromptPresignedUrl: "STRING_VALUE",
// LastModifiedTime: new Date("TIMESTAMP"),
// LastModifiedRegion: "STRING_VALUE",
// };
GetPromptFileCommand Input
See GetPromptFileCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
InstanceId Required | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
PromptId Required | string | undefined | A unique identifier for the prompt. |
GetPromptFileCommand Output
See GetPromptFileCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
LastModifiedRegion | string | undefined | The Amazon Web Services Region where this resource was last modified. |
LastModifiedTime | Date | undefined | The timestamp when this resource was last modified. |
PromptPresignedUrl | string | undefined | A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3. |
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. |