create_refresh_schedule ¶

create_refresh_schedule(
    data_set_id: ResourceId,
    aws_account_id: AwsAccountId,
    schedule: RefreshSchedule,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> CreateRefreshScheduleResponse

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

Parameters:

data_set_id (ResourceId) –

The ID of the dataset.
aws_account_id (AwsAccountId) –

The Amazon Web Services account ID.
schedule (RefreshSchedule) –

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

One or more preconditions aren't met.
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 create_refresh_schedule(
    self,
    data_set_id: "capo_quicksight.types.resource_id.ResourceId",
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    schedule: "capo_quicksight.types.refresh_schedule.RefreshSchedule",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.create_refresh_schedule_response.CreateRefreshScheduleResponse":
    """<p>Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.</p>

    Args:
        data_set_id: <p>The ID of the dataset.</p>
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        schedule: <p>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.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</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.create_refresh_schedule_request.CreateRefreshScheduleRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.create_refresh_schedule_response.CreateRefreshScheduleResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_refresh_schedule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRefreshSchedule")
    )
    input_: capo_quicksight.types.create_refresh_schedule_request.CreateRefreshScheduleRequest = {
        "data_set_id": data_set_id,
        "aws_account_id": aws_account_id,
        "schedule": schedule,
    }

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