CreateContactFlowVersion - Amazon Connect

CreateContactFlowVersion

Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If a version of the same flow content already exists, no new version is created and instead the existing version number is returned. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.

Request Syntax

PUT /contact-flows/InstanceId/ContactFlowId/version HTTP/1.1 Content-type: application/json { "Description": "string", "FlowContentSha256": "string", "LastModifiedRegion": "string", "LastModifiedTime": number }

URI Request Parameters

The request uses the following URI parameters.

ContactFlowId

The identifier of the flow.

Required: Yes

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.

Description

The description of the flow version.

Type: String

Required: No

FlowContentSha256

Indicates the checksum value of the flow content.

Type: String

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

Pattern: ^[a-zA-Z0-9]{64}$

Required: No

LastModifiedRegion

The AWS Region where this resource was last modified.

Type: String

Pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

Required: No

LastModifiedTime

The AWS Region where this resource was last modified.

Type: Timestamp

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ContactFlowArn": "string", "Version": number }

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 flow.

Type: String

Version

The identifier of the flow version.

Type: Long

Valid Range: Minimum value of 1.

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Sample Request

This example illustrates one usage of CreateContactFlowVersion.

{ "Description": "description of the flow version" }

Sample Response

This example illustrates one usage of CreateContactFlowVersion.

{ "ContactFlowArn": "[contact_flow_arn]", "Version": 1 }

See Also

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