Skip to content

describe_refresh_schedule 

describe_refresh_schedule(
    aws_account_id: AwsAccountId,
    data_set_id: ResourceId,
    schedule_id: String,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeRefreshScheduleResponse

Provides a summary of a refresh schedule.

Parameters:

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID.

  • data_set_id (ResourceId) –

    The ID of the dataset.

  • schedule_id (String) –

    The ID of the refresh schedule.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py 
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
def describe_refresh_schedule(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    data_set_id: "capo_quicksight.types.resource_id.ResourceId",
    schedule_id: "capo_quicksight.types.string.String",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_refresh_schedule_response.DescribeRefreshScheduleResponse":
    """<p>Provides a summary of a refresh schedule.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        data_set_id: <p>The ID of the dataset.</p>
        schedule_id: <p>The ID of the refresh schedule.</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.describe_refresh_schedule_request.DescribeRefreshScheduleRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_refresh_schedule_response.DescribeRefreshScheduleResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_refresh_schedule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRefreshSchedule")
    )
    input_: capo_quicksight.types.describe_refresh_schedule_request.DescribeRefreshScheduleRequest = {
        "aws_account_id": aws_account_id,
        "data_set_id": data_set_id,
        "schedule_id": schedule_id,
    }

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