listContactFlowModules method

Future<ListContactFlowModulesResponse> listContactFlowModules({ required String instanceId, ContactFlowModuleState? contactFlowModuleState, int? maxResults, String? nextToken, })

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

May throw AccessDeniedException. May throw InternalServiceException. May throw InvalidParameterException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

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

Parameter contactFlowModuleState : The state of the flow module.

Parameter maxResults : The maximum number of results to return per page.

Parameter nextToken : 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.

Implementation

Future<ListContactFlowModulesResponse> listContactFlowModules({
  required String instanceId,
  ContactFlowModuleState? contactFlowModuleState,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (contactFlowModuleState != null)
      'state': [contactFlowModuleState.value],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/contact-flow-modules-summary/${Uri.encodeComponent(instanceId)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListContactFlowModulesResponse.fromJson(response);
}