Skip to content

delete_schedule 

delete_schedule(
    name: Name,
    *,
    config_overrides: Optional[SchedulerClientConfig] = None,
    group_name: Optional[ScheduleGroupName] = None,
    client_token: Optional[ClientToken] = None,
) -> DeleteScheduleOutput

Deletes the specified schedule.

Parameters:

  • name (Name) –

    The name of the schedule to delete.

  • group_name (Optional[ScheduleGroupName], default: None ) –

    The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

  • client_token (Optional[ClientToken], default: None ) –

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

Raises:

Source code in docs_src/capo_scheduler/_services/scheduler.py 
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
def delete_schedule(
    self,
    name: "capo_scheduler.types.name.Name",
    *,
    config_overrides: Optional[SchedulerClientConfig] = None,
    group_name: Optional[
        "capo_scheduler.types.schedule_group_name.ScheduleGroupName"
    ] = None,
    client_token: Optional["capo_scheduler.types.client_token.ClientToken"] = None,
) -> "capo_scheduler.types.delete_schedule_output.DeleteScheduleOutput":
    """<p>Deletes the specified schedule.</p>

    Args:
        name: <p>The name of the schedule to delete.</p>
        group_name: <p>The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.</p>
        client_token: <p> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. </p>

    Raises:
        capo_scheduler.errors.conflict_exception.ConflictException: <p>Updating or deleting the resource can cause an inconsistent state.</p>
        capo_scheduler.errors.internal_server_exception.InternalServerException: <p>Unexpected error encountered while processing the request.</p>
        capo_scheduler.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource which does not exist.</p>
        capo_scheduler.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_scheduler.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_scheduler.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_scheduler.types.delete_schedule_input.DeleteScheduleInput]",
    ) -> OperationResponse[
        "capo_scheduler.types.delete_schedule_output.DeleteScheduleOutput"
    ]:
        import capo_scheduler._operations.aws_chronos_service.delete_schedule

        output, http_response = (
            capo_scheduler._operations.aws_chronos_service.delete_schedule.delete_schedule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSchedule")
    )
    input_: capo_scheduler.types.delete_schedule_input.DeleteScheduleInput = {
        "name": name
    }
    if group_name is not None:
        input_["group_name"] = group_name
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output