- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateContactFlowModuleMetadataCommand
Updates metadata about specified flow module.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, UpdateContactFlowModuleMetadataCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateContactFlowModuleMetadataCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateContactFlowModuleMetadataRequest
InstanceId: "STRING_VALUE", // required
ContactFlowModuleId: "STRING_VALUE", // required
Name: "STRING_VALUE",
Description: "STRING_VALUE",
State: "ACTIVE" || "ARCHIVED",
};
const command = new UpdateContactFlowModuleMetadataCommand(input);
const response = await client.send(command);
// {};
UpdateContactFlowModuleMetadataCommand Input
See UpdateContactFlowModuleMetadataCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ContactFlowModuleId Required | string | undefined | The identifier of the flow module. |
InstanceId Required | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
Description | string | undefined | The description of the flow module. |
Name | string | undefined | The name of the flow module. |
State | ContactFlowModuleState | undefined | The state of flow module. |
UpdateContactFlowModuleMetadataCommand Output
See UpdateContactFlowModuleMetadataCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
DuplicateResourceException | client | A resource with the specified name already exists. |
InternalServiceException | server | Request processing failed because of an error or failure with the service. |
InvalidParameterException | client | One or more of the specified parameters are not valid. |
InvalidRequestException | client | The request is not valid. |
ResourceNotFoundException | client | The specified resource was not found. |
ThrottlingException | client | The throttling limit has been exceeded. |
ConnectServiceException | Base exception class for all service exceptions from Connect service. |