CreateContactFlowModuleVersion - Amazon Connect

CreateContactFlowModuleVersion

Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.

Request Syntax

PUT /contact-flow-modules/InstanceId/ContactFlowModuleId/version HTTP/1.1 Content-type: application/json { "Description": "string", "FlowModuleContentSha256": "string" }

URI Request Parameters

The request uses the following URI parameters.

ContactFlowModuleId

The identifier of the flow module.

Required: Yes

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Pattern: .*\S.*

Required: No

FlowModuleContentSha256

Indicates the checksum value of the flow module content.

Type: String

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

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

Required: No

Response Syntax

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

ContactFlowModuleArn

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

Type: String

Version

The version of the flow module.

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.

Message

The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message

The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message

The message about the request.

Reason

Reason why the request was invalid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

Message

The message about the limit.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

Message

The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Sample Request

This example illustrates one usage of CreateContactFlowModuleVersion.

{ "Description": "Initial version of the customer service module" }

Sample Response

This example illustrates one usage of CreateContactFlowModuleVersion.

{ "ContactFlowModuleArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl", "Version": 1 }

See Also

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