CreateContactFlow - Amazon Connect Service

CreateContactFlow

Creates a contact flow for the specified Amazon Connect instance.

You can also create and update contact flows using the Amazon Connect Flow language.

Request Syntax

PUT /contact-flows/InstanceId HTTP/1.1 Content-type: application/json { "Content": "string", "Description": "string", "Name": "string", "Tags": { "string" : "string" }, "Type": "string" }

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Content

The content of the contact flow.

Type: String

Required: Yes

Description

The description of the contact flow.

Type: String

Required: No

Name

The name of the contact flow.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Tags

One or more tags.

Type: String to string map

Map Entries: Maximum number of 200 items.

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

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Type

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

Type: String

Valid Values: CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ContactFlowArn": "string", "ContactFlowId": "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.

ContactFlowArn

The Amazon Resource Name (ARN) of the contact flow.

Type: String

ContactFlowId

The identifier of the contact flow.

Type: String

Length Constraints: Maximum length of 500.

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 due to an error or failure with the service.

HTTP Status Code: 500

InvalidContactFlowException

The contact flow is not valid.

HTTP Status Code: 400

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: