CreateContactFlowModuleCommand

Suggest an Edit

Creates a flow module for the specified Amazon Connect instance.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, CreateContactFlowModuleCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, CreateContactFlowModuleCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // CreateContactFlowModuleRequest
  InstanceId: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  Content: "STRING_VALUE", // required
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
  ClientToken: "STRING_VALUE",
};
const command = new CreateContactFlowModuleCommand(input);
const response = await client.send(command);
// { // CreateContactFlowModuleResponse
//   Id: "STRING_VALUE",
//   Arn: "STRING_VALUE",
// };

CreateContactFlowModuleCommand Input

See CreateContactFlowModuleCommandInput for more details

Parameter
Type
Description
Content
Required
string | undefined

The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language .

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.

Name
Required
string | undefined

The name of the flow module.

ClientToken
string | undefined

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .

Description
string | undefined

The description of the flow module.

Tags
Record<string, string> | undefined

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

CreateContactFlowModuleCommand Output

See CreateContactFlowModuleCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The Amazon Resource Name (ARN) of the flow module.

Id
string | undefined

The identifier of the flow module.

Throws

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.

IdempotencyException
client

An entity with the same name already exists.

InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidContactFlowModuleException
client

The problems with the module. Please fix before trying again.

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

LimitExceededException
client

The allowed limit for the resource has been exceeded.

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.