describe_refresh_schedule `async` ¶

describe_refresh_schedule(
    aws_account_id: AwsAccountId,
    data_set_id: ResourceId,
    schedule_id: String,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = 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:

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

A limit is exceeded.
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_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[AsyncQuickSightClientConfig] = 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.describe_refresh_schedule_request.DescribeRefreshScheduleRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_refresh_schedule_response.DescribeRefreshScheduleResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_refresh_schedule

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.describe_refresh_schedule.async_describe_refresh_schedule(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_refresh_schedule async ¶

describe_refresh_schedule `async` ¶