Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdatePrompt

Updates a prompt.

Request Syntax


POST /prompts/InstanceId/PromptId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "S3Uri": "string"
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

PromptId

A unique identifier for the prompt.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

A description of the prompt.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 250.

Required: No

Name

The name of the prompt.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Required: No

S3Uri

The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: s3://\S+/.+|https://\\S+\\.s3\\.\\S+\\.amazonaws\\.com/\\S+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "PromptARN": "string",
   "PromptId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PromptARN

The Amazon Resource Name (ARN) of the prompt.

Type: String

PromptId

A unique identifier for the prompt.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429