AssociateFlowCommand

Associates a connect resource to a flow.

Example Syntax

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

import { ConnectClient, AssociateFlowCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, AssociateFlowCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // AssociateFlowRequest
  InstanceId: "STRING_VALUE", // required
  ResourceId: "STRING_VALUE", // required
  FlowId: "STRING_VALUE", // required
  ResourceType: "SMS_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL" || "ANALYTICS_CONNECTOR" || "WHATSAPP_MESSAGING_PHONE_NUMBER", // required
};
const command = new AssociateFlowCommand(input);
const response = await client.send(command);
// {};

AssociateFlowCommand Input

See AssociateFlowCommandInput for more details

Parameter
Type
Description
FlowId
Required
string | undefined

The identifier of the flow.

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.

ResourceId
Required
string | undefined

The identifier of the resource.

  • Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

  • Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

ResourceType
Required
FlowAssociationResourceType | undefined

A valid resource type.

AssociateFlowCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action.

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.