describe_topic_refresh `async` ¶

describe_topic_refresh(
    aws_account_id: AwsAccountId,
    topic_id: TopicId,
    refresh_id: ResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> DescribeTopicRefreshResponse

Describes the status of a topic refresh.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.
topic_id (TopicId) –

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
refresh_id (ResourceId) –

The ID of the refresh, which is performed when the topic is created or updated.

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

An internal failure occurred.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
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/async_quick_sight.py

async def describe_topic_refresh(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    topic_id: "capo_quicksight.types.topic_id.TopicId",
    refresh_id: "capo_quicksight.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_topic_refresh_response.DescribeTopicRefreshResponse":
    """<p>Describes the status of a topic refresh.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.</p>
        topic_id: <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
        refresh_id: <p>The ID of the refresh, which is performed when the topic is created or updated.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.describe_topic_refresh_request.DescribeTopicRefreshRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_topic_refresh_response.DescribeTopicRefreshResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_topic_refresh

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.describe_topic_refresh.async_describe_topic_refresh(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTopicRefresh")
    )
    input_: capo_quicksight.types.describe_topic_refresh_request.DescribeTopicRefreshRequest = {
        "aws_account_id": aws_account_id,
        "topic_id": topic_id,
        "refresh_id": refresh_id,
    }

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

describe_topic_refresh async ¶

describe_topic_refresh `async` ¶