describe_scheduled_actions async ¶

async def describe_scheduled_actions(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    scheduled_action_name: Optional["capo_redshift.types.string.String"] = None,
    target_action_type: Optional[
        "capo_redshift.types.scheduled_action_type_values.ScheduledActionTypeValues"
    ] = None,
    start_time: Optional["capo_redshift.types.t_stamp.TStamp"] = None,
    end_time: Optional["capo_redshift.types.t_stamp.TStamp"] = None,
    active: Optional["capo_redshift.types.boolean_optional.BooleanOptional"] = None,
    filters: Optional[
        "capo_redshift.types.scheduled_action_filter_list.ScheduledActionFilterList"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
) -> "capo_redshift.types.scheduled_actions_message.ScheduledActionsMessage":
    """<p>Describes properties of scheduled actions. </p>

    Args:
        scheduled_action_name: <p>The name of the scheduled action to retrieve. </p>
        target_action_type: <p>The type of the scheduled actions to retrieve. </p>
        start_time: <p>The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.</p>
        end_time: <p>The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.</p>
        active: <p>If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. </p>
        filters: <p>List of scheduled action filters. </p>
        marker: <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeScheduledActions</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>
        max_records: <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>

    Raises:
        capo_redshift.errors.scheduled_action_not_found_fault.ScheduledActionNotFoundFault: <p>The scheduled action cannot be found. </p>
        capo_redshift.errors.unauthorized_operation.UnauthorizedOperation: <p>Your account is not authorized to perform the requested operation.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift.types.describe_scheduled_actions_message.DescribeScheduledActionsMessage]",
    ) -> AsyncOperationResponse[
        "capo_redshift.types.scheduled_actions_message.ScheduledActionsMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_scheduled_actions

        (
            output,
            http_response,
        ) = await capo_redshift._operations.redshift_service_version20121201.describe_scheduled_actions.async_describe_scheduled_actions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeScheduledActions")
    )
    input_: capo_redshift.types.describe_scheduled_actions_message.DescribeScheduledActionsMessage = {}
    if scheduled_action_name is not None:
        input_["scheduled_action_name"] = scheduled_action_name
    if target_action_type is not None:
        input_["target_action_type"] = target_action_type
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if active is not None:
        input_["active"] = active
    if filters is not None:
        input_["filters"] = filters
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records

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