describe_topic_refresh_schedule ¶

describe_topic_refresh_schedule(
    aws_account_id: AwsAccountId,
    topic_id: TopicId,
    dataset_id: String,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeTopicRefreshScheduleResponse

Deletes a topic refresh schedule.

Parameters:

aws_account_id (AwsAccountId) –

The Amazon Web Services account ID.
topic_id (TopicId) –

The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dataset_id (String) –

The ID of the dataset.

Raises:

AccessDeniedException –

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.
ConflictException –

Updating or deleting a resource can cause an inconsistent state.
InternalFailureException –

An internal failure occurred.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
LimitExceededException –

A limit is exceeded.
ResourceExistsException –

The resource specified already exists.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/quick_sight.py

def describe_topic_refresh_schedule(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    topic_id: "capo_quicksight.types.topic_id.TopicId",
    dataset_id: "capo_quicksight.types.string.String",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_topic_refresh_schedule_response.DescribeTopicRefreshScheduleResponse":
    """<p>Deletes a topic refresh schedule.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        topic_id: <p>The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
        dataset_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.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</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_exists_exception.ResourceExistsException: <p>The resource specified already exists. </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_topic_refresh_schedule_request.DescribeTopicRefreshScheduleRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_topic_refresh_schedule_response.DescribeTopicRefreshScheduleResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_topic_refresh_schedule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTopicRefreshSchedule")
    )
    input_: capo_quicksight.types.describe_topic_refresh_schedule_request.DescribeTopicRefreshScheduleRequest = {
        "aws_account_id": aws_account_id,
        "topic_id": topic_id,
        "dataset_id": dataset_id,
    }

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