delete_schedule async ¶

async def delete_schedule(
    self,
    name: "capo_scheduler.types.name.Name",
    *,
    config_overrides: Optional[AsyncSchedulerClientConfig] = 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.
    """

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

        (
            output,
            http_response,
        ) = await capo_scheduler._operations.aws_chronos_service.delete_schedule.async_delete_schedule(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output