update_quick_sight_q_search_configuration ¶

update_quick_sight_q_search_configuration(
    aws_account_id: AwsAccountId,
    q_search_status: QSearchStatus,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> UpdateQuickSightQSearchConfigurationResponse

Updates the state of a Quick Sight Q Search configuration.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.
q_search_status (QSearchStatus) –

The status of the Quick Sight Q Search configuration that the user wants to update.

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.
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 update_quick_sight_q_search_configuration(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    q_search_status: "capo_quicksight.types.q_search_status.QSearchStatus",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.update_quick_sight_q_search_configuration_response.UpdateQuickSightQSearchConfigurationResponse":
    """<p>Updates the state of a Quick Sight Q Search configuration.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.</p>
        q_search_status: <p>The status of the Quick Sight Q Search configuration that the user wants to update.</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.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.update_quick_sight_q_search_configuration_request.UpdateQuickSightQSearchConfigurationRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.update_quick_sight_q_search_configuration_response.UpdateQuickSightQSearchConfigurationResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.update_quick_sight_q_search_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateQuickSightQSearchConfiguration")
    )
    input_: capo_quicksight.types.update_quick_sight_q_search_configuration_request.UpdateQuickSightQSearchConfigurationRequest = {
        "aws_account_id": aws_account_id,
        "q_search_status": q_search_status,
    }

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