updateSession method

Future<void> updateSession({ required String farmId, required String jobId, required String queueId, required String sessionId, required SessionLifecycleTargetStatus targetLifecycleStatus, String? clientToken, })

Updates a session.

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

Parameter farmId : The farm ID to update in the session.

Parameter jobId : The job ID to update in the session.

Parameter queueId : The queue ID to update in the session.

Parameter sessionId : The session ID to update.

Parameter targetLifecycleStatus : The life cycle status to update in the session.

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

Implementation

Future<void> updateSession({
  required String farmId,
  required String jobId,
  required String queueId,
  required String sessionId,
  required SessionLifecycleTargetStatus targetLifecycleStatus,
  String? clientToken,
}) async {
  final headers = <String, String>{
    if (clientToken != null) 'X-Amz-Client-Token': clientToken.toString(),
  };
  final $payload = <String, dynamic>{
    'targetLifecycleStatus': targetLifecycleStatus.value,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PATCH',
    requestUri:
        '/2023-10-12/farms/${Uri.encodeComponent(farmId)}/queues/${Uri.encodeComponent(queueId)}/jobs/${Uri.encodeComponent(jobId)}/sessions/${Uri.encodeComponent(sessionId)}',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
}