list_contact_flow_modules

Connect.Client.list_contact_flow_modules(**kwargs)

Provides information about the flow modules for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_contact_flow_modules(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    ContactFlowModuleState='ACTIVE'|'ARCHIVED'
)

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.

• NextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
• MaxResults (integer) -- The maximum number of results to return per page.
• ContactFlowModuleState (string) -- The state of the flow module.

Return type

dict

Returns

Response Syntax

{
    'ContactFlowModulesSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'ARCHIVED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ContactFlowModulesSummaryList (list) --

    Information about the flow module.

    • (dict) --

      Contains summary information about a flow.

      • Id (string) --

        The identifier of the flow module.

      • Arn (string) --

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

      • Name (string) --

        The name of the flow module.

      • State (string) --

        The type of flow module.

  • NextToken (string) --

    If there are additional results, this is the token for the next set of results.

Exceptions

• Connect.Client.exceptions.AccessDeniedException
• Connect.Client.exceptions.InvalidRequestException
• Connect.Client.exceptions.InvalidParameterException
• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.ThrottlingException
• Connect.Client.exceptions.InternalServiceException