updateQueueEnvironment method

Future<void> updateQueueEnvironment({ required String farmId, required String queueEnvironmentId, required String queueId, String? clientToken, int? priority, String? template, EnvironmentTemplateType? templateType, })

Updates the queue environment.

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

Parameter farmId : The farm ID of the queue environment to update.

Parameter queueEnvironmentId : The queue environment ID to update.

Parameter queueId : The queue ID of the queue environment to update.

Parameter clientToken : The unique token which the server uses to recognize retries of the same request.

Parameter priority : The priority to update.

Parameter template : The template to update.

Parameter templateType : The template type to update.

Implementation

Future<void> updateQueueEnvironment({
  required String farmId,
  required String queueEnvironmentId,
  required String queueId,
  String? clientToken,
  int? priority,
  String? template,
  EnvironmentTemplateType? templateType,
}) async {
  _s.validateNumRange(
    'priority',
    priority,
    0,
    10000,
  );
  final headers = <String, String>{
    if (clientToken != null) 'X-Amz-Client-Token': clientToken.toString(),
  };
  final $payload = <String, dynamic>{
    if (priority != null) 'priority': priority,
    if (template != null) 'template': template,
    if (templateType != null) 'templateType': templateType.value,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PATCH',
    requestUri:
        '/2023-10-12/farms/${Uri.encodeComponent(farmId)}/queues/${Uri.encodeComponent(queueId)}/environments/${Uri.encodeComponent(queueEnvironmentId)}',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
}