UpdateContactFlowMetadata - Amazon Connect

UpdateContactFlowMetadata

Updates metadata about specified flow.

Request Syntax

POST /contact-flows/InstanceId/ContactFlowId/metadata HTTP/1.1 Content-type: application/json { "ContactFlowState": "string", "Description": "string", "Name": "string" }

URI Request Parameters

The request uses the following URI parameters.

ContactFlowId

The identifier of the flow.

Length Constraints: Maximum length of 500.

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.

ContactFlowState

The state of flow.

Type: String

Valid Values: ACTIVE | ARCHIVED

Required: No

Description

The description of the flow.

Type: String

Required: No

Name

The name of the flow.

Type: String

Length Constraints: Minimum length of 1.

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.

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

See Also

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