Skip to content

update_subscription async

update_subscription(
    application_id: ApplicationId,
    subscription_id: SubscriptionId,
    type: SubscriptionType,
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
) -> UpdateSubscriptionResponse

Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

Parameters:

  • application_id (ApplicationId) –

    The identifier of the Amazon Q Business application where the subscription update should take effect.

  • subscription_id (SubscriptionId) –

    The identifier of the Amazon Q Business subscription to be updated.

  • type (SubscriptionType) –

    The type of the Amazon Q Business subscription to be updated.

Raises:

  • AccessDeniedException –

    You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ConflictException –

    You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

  • InternalServerException –

    An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

  • ResourceNotFoundException –

    The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException –

    The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_qbusiness/_services/async_q_business.py
async def update_subscription(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    subscription_id: "capo_qbusiness.types.subscription_id.SubscriptionId",
    type: "capo_qbusiness.types.subscription_type.SubscriptionType",
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
) -> "capo_qbusiness.types.update_subscription_response.UpdateSubscriptionResponse":
    """<p>Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p>

    Args:
        application_id: <p>The identifier of the Amazon Q Business application where the subscription update should take effect.</p>
        subscription_id: <p>The identifier of the Amazon Q Business subscription to be updated.</p>
        type: <p>The type of the Amazon Q Business subscription to be updated.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.conflict_exception.ConflictException: <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qbusiness.types.update_subscription_request.UpdateSubscriptionRequest]",
    ) -> AsyncOperationResponse[
        "capo_qbusiness.types.update_subscription_response.UpdateSubscriptionResponse"
    ]:
        import capo_qbusiness._operations.expert_q.update_subscription

        (
            output,
            http_response,
        ) = await capo_qbusiness._operations.expert_q.update_subscription.async_update_subscription(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSubscription")
    )
    input_: capo_qbusiness.types.update_subscription_request.UpdateSubscriptionRequest = {
        "application_id": application_id,
        "subscription_id": subscription_id,
        "type": type,
    }

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