Skip to content

update_crawler_schedule async

update_crawler_schedule(
    crawler_name: NameString,
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    schedule: Optional[CronExpression] = None,
) -> UpdateCrawlerScheduleResponse

Updates the schedule of a crawler using a cron expression.

Parameters:

Raises:

Source code in docs_src/capo_glue/_services/async_glue.py
async def update_crawler_schedule(
    self,
    crawler_name: "capo_glue.types.name_string.NameString",
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    schedule: Optional["capo_glue.types.cron_expression.CronExpression"] = None,
) -> (
    "capo_glue.types.update_crawler_schedule_response.UpdateCrawlerScheduleResponse"
):
    """<p>Updates the schedule of a crawler using a <code>cron</code> expression. </p>

    Args:
        crawler_name: <p>The name of the crawler whose schedule to update.</p>
        schedule: <p>The updated <code>cron</code> expression used to specify the schedule (see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html">Time-Based Schedules for Jobs and Crawlers</a>. For example, to run something every day at 12:15 UTC, you would specify: <code>cron(15 12 * * ? *)</code>.</p>

    Raises:
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.scheduler_transitioning_exception.SchedulerTransitioningException: <p>The specified scheduler is transitioning.</p>
        capo_glue.errors.version_mismatch_exception.VersionMismatchException: <p>There was a version conflict.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_glue.types.update_crawler_schedule_request.UpdateCrawlerScheduleRequest]",
    ) -> AsyncOperationResponse[
        "capo_glue.types.update_crawler_schedule_response.UpdateCrawlerScheduleResponse"
    ]:
        import capo_glue._operations.aws_glue.update_crawler_schedule

        (
            output,
            http_response,
        ) = await capo_glue._operations.aws_glue.update_crawler_schedule.async_update_crawler_schedule(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCrawlerSchedule")
    )
    input_: capo_glue.types.update_crawler_schedule_request.UpdateCrawlerScheduleRequest = {
        "crawler_name": crawler_name
    }
    if schedule is not None:
        input_["schedule"] = schedule

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output