create_topic_refresh_schedule `async` ¶

create_topic_refresh_schedule(
    aws_account_id: AwsAccountId,
    topic_id: TopicId,
    dataset_arn: Arn,
    refresh_schedule: TopicRefreshSchedule,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    dataset_name: Optional[String] = None,
) -> CreateTopicRefreshScheduleResponse

Creates a topic refresh schedule.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the topic you're creating a refresh schedule for.
topic_id (TopicId) –

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

The Amazon Resource Name (ARN) of the dataset.
dataset_name (Optional[String], default: None ) –

The name of the dataset.
refresh_schedule (TopicRefreshSchedule) –

The definition of a 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.
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/async_quick_sight.py

async def create_topic_refresh_schedule(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    topic_id: "capo_quicksight.types.topic_id.TopicId",
    dataset_arn: "capo_quicksight.types.arn.Arn",
    refresh_schedule: "capo_quicksight.types.topic_refresh_schedule.TopicRefreshSchedule",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    dataset_name: Optional["capo_quicksight.types.string.String"] = None,
) -> "capo_quicksight.types.create_topic_refresh_schedule_response.CreateTopicRefreshScheduleResponse":
    """<p>Creates a topic refresh schedule.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the topic you're creating a refresh schedule for.</p>
        topic_id: <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
        dataset_arn: <p>The Amazon Resource Name (ARN) of the dataset.</p>
        dataset_name: <p>The name of the dataset.</p>
        refresh_schedule: <p>The definition of a 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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.create_topic_refresh_schedule_request.CreateTopicRefreshScheduleRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.create_topic_refresh_schedule_response.CreateTopicRefreshScheduleResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_topic_refresh_schedule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateTopicRefreshSchedule")
    )
    input_: capo_quicksight.types.create_topic_refresh_schedule_request.CreateTopicRefreshScheduleRequest = {
        "aws_account_id": aws_account_id,
        "topic_id": topic_id,
        "dataset_arn": dataset_arn,
        "refresh_schedule": refresh_schedule,
    }
    if dataset_name is not None:
        input_["dataset_name"] = dataset_name

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

create_topic_refresh_schedule async ¶

create_topic_refresh_schedule `async` ¶