Skip to content

update_scheduled_action async

update_scheduled_action(
    scheduled_action_name: ScheduledActionName,
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = None,
    target_action: Optional[TargetAction] = None,
    schedule: Optional[Schedule] = None,
    role_arn: Optional[IamRoleArn] = None,
    enabled: Optional[bool] = None,
    scheduled_action_description: Optional[str] = None,
    start_time: Optional[datetime] = None,
    end_time: Optional[datetime] = None,
) -> UpdateScheduledActionResponse

Updates a scheduled action.

Parameters:

  • scheduled_action_name (ScheduledActionName) –

    The name of the scheduled action to update to.

  • schedule (Optional[Schedule], default: None ) –

    The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

    • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

    • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

  • role_arn (Optional[IamRoleArn], default: None ) –

    The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide

  • enabled (Optional[bool], default: None ) –

    Specifies whether to enable the scheduled action.

  • scheduled_action_description (Optional[str], default: None ) –

    The descripion of the scheduled action to update to.

  • start_time (Optional[datetime], default: None ) –

    The start time in UTC of the scheduled action to update to.

  • end_time (Optional[datetime], default: None ) –

    The end time in UTC of the scheduled action to update.

Raises:

Source code in docs_src/capo_redshift_serverless/_services/async_redshift_serverless.py
async def update_scheduled_action(
    self,
    scheduled_action_name: "capo_redshift_serverless.types.scheduled_action_name.ScheduledActionName",
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = None,
    target_action: Optional[
        "capo_redshift_serverless.types.target_action.TargetAction"
    ] = None,
    schedule: Optional["capo_redshift_serverless.types.schedule.Schedule"] = None,
    role_arn: Optional[
        "capo_redshift_serverless.types.iam_role_arn.IamRoleArn"
    ] = None,
    enabled: Optional[bool] = None,
    scheduled_action_description: Optional[str] = None,
    start_time: Optional[datetime.datetime] = None,
    end_time: Optional[datetime.datetime] = None,
) -> "capo_redshift_serverless.types.update_scheduled_action_response.UpdateScheduledActionResponse":
    """<p>Updates a scheduled action.</p>

    Args:
        scheduled_action_name: <p>The name of the scheduled action to update to.</p>
        schedule: <p>The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.</p> <ul> <li> <p>Format of at timestamp is <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2016-03-04T17:27:00</code>.</p> </li> <li> <p>Format of cron expression is <code>(Minutes Hours Day-of-month Month Day-of-week Year)</code>. For example, <code>"(0 10 ? * MON *)"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> </li> </ul>
        role_arn: <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the Amazon Redshift Management Guide</p>
        enabled: <p>Specifies whether to enable the scheduled action.</p>
        scheduled_action_description: <p>The descripion of the scheduled action to update to.</p>
        start_time: <p>The start time in UTC of the scheduled action to update to.</p>
        end_time: <p>The end time in UTC of the scheduled action to update.</p>

    Raises:
        capo_redshift_serverless.errors.conflict_exception.ConflictException: <p>The submitted action has conflicts.</p>
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift_serverless.types.update_scheduled_action_request.UpdateScheduledActionRequest]",
    ) -> AsyncOperationResponse[
        "capo_redshift_serverless.types.update_scheduled_action_response.UpdateScheduledActionResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.update_scheduled_action

        (
            output,
            http_response,
        ) = await capo_redshift_serverless._operations.redshift_serverless.update_scheduled_action.async_update_scheduled_action(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateScheduledAction")
    )
    input_: capo_redshift_serverless.types.update_scheduled_action_request.UpdateScheduledActionRequest = {
        "scheduled_action_name": scheduled_action_name
    }
    if target_action is not None:
        input_["target_action"] = target_action
    if schedule is not None:
        input_["schedule"] = schedule
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if enabled is not None:
        input_["enabled"] = enabled
    if scheduled_action_description is not None:
        input_["scheduled_action_description"] = scheduled_action_description
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time

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