listQuickConnects method

Future<ListQuickConnectsResponse> listQuickConnects({ required String instanceId, int? maxResults, String? nextToken, List<QuickConnectType>? quickConnectTypes, })

This API is in preview release for Amazon Connect and is subject to change.

Provides information about the quick connects for the specified Amazon Connect instance.

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 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.

Parameter quickConnectTypes : The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Implementation

Future<ListQuickConnectsResponse> listQuickConnects({
  required String instanceId,
  int? maxResults,
  String? nextToken,
  List<QuickConnectType>? quickConnectTypes,
}) 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 (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (quickConnectTypes != null)
      'QuickConnectTypes': quickConnectTypes.map((e) => e.toValue()).toList(),
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/quick-connects/${Uri.encodeComponent(instanceId)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListQuickConnectsResponse.fromJson(response);
}