listJobParameterDefinitions method

Future<ListJobParameterDefinitionsResponse> listJobParameterDefinitions({ required String farmId, required String jobId, required String queueId, int? maxResults, String? nextToken, })

Lists parameter definitions of a job.

May throw AccessDeniedException. May throw InternalServerErrorException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter farmId : The farm ID of the job to list.

Parameter jobId : The job ID to include on the list.

Parameter queueId : The queue ID to include on the list.

Parameter maxResults : The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Parameter nextToken : The token for the next set of results, or null to start from the beginning.

Implementation

Future<ListJobParameterDefinitionsResponse> listJobParameterDefinitions({
  required String farmId,
  required String jobId,
  required String queueId,
  int? maxResults,
  String? nextToken,
}) async {
  _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:
        '/2023-10-12/farms/${Uri.encodeComponent(farmId)}/queues/${Uri.encodeComponent(queueId)}/jobs/${Uri.encodeComponent(jobId)}/parameter-definitions',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListJobParameterDefinitionsResponse.fromJson(response);
}