UpdateContactFlowModuleAlias
Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
Request Syntax
POST /contact-flow-modules/InstanceId/ContactFlowModuleId/alias/AliasId HTTP/1.1
Content-type: application/json
{
"ContactFlowModuleVersion": number,
"Description": "string",
"Name": "string"
}URI Request Parameters
The request uses the following URI parameters.
- AliasId
-
The identifier of the alias.
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
- ContactFlowModuleId
-
The identifier of the flow module.
Length Constraints: Minimum length of 1. Maximum length of 256.
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 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.
- ContactFlowModuleVersion
-
The version of the flow module.
Type: Long
Valid Range: Minimum value of 1.
Required: No
- Description
-
The description of the alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
.*\S.*Required: No
- Name
-
The name of the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
.*\S.*Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ConditionalOperationFailedException
-
Request processing failed because dependent condition failed.
HTTP Status Code: 409
- 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
- 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 UpdateContactFlowModuleAlias.
{ "Name": "production-v2", "Description": "Updated production version with new features", "ContactFlowModuleVersion": 3 }
Sample Response
This example illustrates one usage of UpdateContactFlowModuleAlias.
HTTP/1.1 200 OK
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
