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

GetFlowAssociation

Retrieves the flow associated for a given resource.

Request Syntax


GET /flow-associations/InstanceId/ResourceId/ResourceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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

ResourceId

The identifier of the resource.

AWS End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER
AWS End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

Required: Yes

ResourceType

A valid resource type.

Valid Values: SMS_PHONE_NUMBER | INBOUND_EMAIL | OUTBOUND_EMAIL | ANALYTICS_CONNECTOR | WHATSAPP_MESSAGING_PHONE_NUMBER

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "FlowId": "string",
   "ResourceId": "string",
   "ResourceType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FlowId

The identifier of the flow.

Type: String

ResourceId

The identifier of the resource.

Type: String

ResourceType

A valid resource type.

Type: String

Valid Values: SMS_PHONE_NUMBER | INBOUND_EMAIL | OUTBOUND_EMAIL | ANALYTICS_CONNECTOR | WHATSAPP_MESSAGING_PHONE_NUMBER

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

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