listUseCases method

Future<ListUseCasesResponse> listUseCases({ required String instanceId, required String integrationAssociationId, int? maxResults, String? nextToken, })

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

List the use cases.

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

Parameter instanceId : The identifier of the Amazon Connect instance.

Parameter integrationAssociationId : The identifier for the integration association.

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<ListUseCasesResponse> listUseCases({
  required String instanceId,
  required String integrationAssociationId,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(instanceId, 'instanceId');
  _s.validateStringLength(
    'instanceId',
    instanceId,
    1,
    100,
    isRequired: true,
  );
  ArgumentError.checkNotNull(
      integrationAssociationId, 'integrationAssociationId');
  _s.validateStringLength(
    'integrationAssociationId',
    integrationAssociationId,
    1,
    200,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/instance/${Uri.encodeComponent(instanceId)}/integration-associations/${Uri.encodeComponent(integrationAssociationId)}/use-cases',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListUseCasesResponse.fromJson(response);
}