listContactFlows method

Future<ListContactFlowsResponse> listContactFlows({ required String instanceId, List<ContactFlowType>? contactFlowTypes, int? maxResults, String? nextToken, })

Provides information about the contact flows for the specified Amazon Connect instance.

You can also create and update contact flows using the Amazon Connect Flow language.

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

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

Parameter instanceId : The identifier of the Amazon Connect instance.

Parameter contactFlowTypes : The type of contact flow.

Parameter maxResults : The maximimum 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<ListContactFlowsResponse> listContactFlows({
  required String instanceId,
  List<ContactFlowType>? contactFlowTypes,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(instanceId, 'instanceId');
  _s.validateStringLength(
    'instanceId',
    instanceId,
    1,
    100,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (contactFlowTypes != null)
      'contactFlowTypes': contactFlowTypes.map((e) => e.toValue()).toList(),
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/contact-flows-summary/${Uri.encodeComponent(instanceId)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListContactFlowsResponse.fromJson(response);
}