Connect / Client / batch_get_flow_association

batch_get_flow_association#

Connect.Client.batch_get_flow_association(**kwargs)#

Retrieve the flow associations for the given resources.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_flow_association(
    InstanceId='string',
    ResourceIds=[
        'string',
    ],
    ResourceType='WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'
)
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.

  • ResourceIds (list) –

    [REQUIRED]

    A list of resource identifiers to retrieve flow associations.

    • 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

    • (string) –

  • ResourceType (string) – The type of resource association.

Return type:

dict

Returns:

Response Syntax

{
    'FlowAssociationSummaryList': [
        {
            'ResourceId': 'string',
            'FlowId': 'string',
            'ResourceType': 'WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'
        },
    ]
}

Response Structure

  • (dict) –

    • FlowAssociationSummaryList (list) –

      Information about flow associations.

      • (dict) –

        Information about flow associations.

        • ResourceId (string) –

          The identifier of the resource.

        • FlowId (string) –

          The identifier of the flow.

        • ResourceType (string) –

          The type of resource association.

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