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

UpdateContactFlowModuleMetadata

Updates metadata about specified flow module.

Request Syntax


POST /contact-flow-modules/InstanceId/ContactFlowModuleId/metadata HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "State": "string"
}

URI Request Parameters

The request uses the following URI parameters.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The description of the flow module.

Type: String

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

Pattern: .*\S.*

Required: No

Name

The name of the flow module.

Type: String

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

Pattern: .*\S.*

Required: No

State

The state of flow module.

Type: String

Valid Values: ACTIVE | ARCHIVED

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

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.

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429