ConnectScheduling / Client / cancel_time_off

cancel_time_off

ConnectScheduling.Client.cancel_time_off(**kwargs)

Cancels a time off request.

Cancelling a CANCELLED request succeeds without a change. Returns ConflictException if the request is PENDING, which means Connect Customer is still processing the request asynchronously. Wait until GetTimeOff returns a status other than PENDING, and then retry.

See also: AWS API Documentation

Request Syntax

response = client.cancel_time_off(
    InstanceId='string',
    UserId='string',
    TimeOffId='string',
    Description='string'
)
Parameters:
  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Connect Customer instance. This can be the ID or the ARN of the instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • UserId (string) –

    [REQUIRED]

    The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.

  • TimeOffId (string) –

    [REQUIRED]

    The unique identifier of the time off request to cancel. If the time off request doesn’t belong to UserId, the operation returns ResourceNotFoundException.

  • Description (string) – A description recorded with the cancellation. It replaces the description of the time off request. If you omit it, the request’s description is removed.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The response for CancelTimeOff.

Exceptions