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

CreatePrompt

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.

Request Syntax


PUT /prompts/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "S3Uri": "string",
   "Tags": { 
      "string" : "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

Request Body

The request accepts the following data in JSON format.

Description

The 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: Yes

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: Yes

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

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.

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

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

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429