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

CreateContactFlowAlias

Creates a named alias that points to a specific version of a flow.

Request Syntax


PUT /contact-flows/InstanceId/ContactFlowId/alias HTTP/1.1
Content-type: application/json

{
   "AliasName": "string",
   "ContactFlowVersion": number,
   "Description": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ContactFlowId

The identifier of the flow.

Required: Yes

InstanceId

The identifier of the Connect Customer 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 250.

Pattern: ^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

AliasName

The name of the alias.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

ContactFlowVersion

The version of the flow.

Type: Long

Valid Range: Minimum value of 1.

Required: Yes

Description

The description of the alias.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowArn": "string",
   "Id": "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 flow.

Type: String

Id

The identifier of the alias.

Type: String

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

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

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.

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


{
  "AliasName": "production",
  "ContactFlowVersion": 2,
  "Description": "Production version of the customer service flow"
}

Sample Response

This example illustrates one usage of CreateContactFlowAlias.


{
  "ContactFlowArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/contact-flow/abcdefgh-1234-5678-9012-abcdefghijkl",
  "Id": "87654321-4321-4321-4321-210987654321"
}