Connect / Client / get_flow_association

get_flow_association

Connect.Client.get_flow_association(**kwargs)

Retrieves the flow associated for a given resource.

See also: AWS API Documentation

Request Syntax

response = client.get_flow_association(
    InstanceId='string',
    ResourceId='string',
    ResourceType='SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER'
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• ResourceId (string) –

  [REQUIRED]

  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 (string) –

  [REQUIRED]

  A valid resource type.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceId': 'string',
    'FlowId': 'string',
    'ResourceType': 'SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER'
}

Response Structure

• (dict) –

  • ResourceId (string) –

    The identifier of the resource.

  • FlowId (string) –

    The identifier of the flow.

  • ResourceType (string) –

    A valid resource type.

Exceptions

• Connect.Client.exceptions.AccessDeniedException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ThrottlingException