Skip to content

list_refresh_schedules

list_refresh_schedules(
    aws_account_id: AwsAccountId,
    data_set_id: ResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> ListRefreshSchedulesResponse

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

Parameters:

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID.

  • data_set_id (ResourceId) –

    The ID of the dataset.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def list_refresh_schedules(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    data_set_id: "capo_quicksight.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.list_refresh_schedules_response.ListRefreshSchedulesResponse":
    """<p>Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules. </p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        data_set_id: <p>The ID of the dataset.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.list_refresh_schedules_request.ListRefreshSchedulesRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.list_refresh_schedules_response.ListRefreshSchedulesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_refresh_schedules

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.list_refresh_schedules.list_refresh_schedules(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRefreshSchedules")
    )
    input_: capo_quicksight.types.list_refresh_schedules_request.ListRefreshSchedulesRequest = {
        "aws_account_id": aws_account_id,
        "data_set_id": data_set_id,
    }

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