Skip to content

describe_default_q_business_application async

describe_default_q_business_application(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    namespace: Optional[Namespace] = None,
) -> DescribeDefaultQBusinessApplicationResponse

Describes a Amazon Q Business application that is linked to an Quick Sight account.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Quick Sight account that is linked to the Amazon Q Business application that you want described.

  • namespace (Optional[Namespace], default: None ) –

    The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

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.

  • 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_default_q_business_application(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    namespace: Optional["capo_quicksight.types.namespace.Namespace"] = None,
) -> "capo_quicksight.types.describe_default_q_business_application_response.DescribeDefaultQBusinessApplicationResponse":
    """<p>Describes a Amazon Q Business application that is linked to an Quick Sight account.</p>

    Args:
        aws_account_id: <p>The ID of the Quick Sight account that is linked to the Amazon Q Business application that you want described.</p>
        namespace: <p>The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.</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.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_default_q_business_application_request.DescribeDefaultQBusinessApplicationRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_default_q_business_application_response.DescribeDefaultQBusinessApplicationResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_default_q_business_application

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDefaultQBusinessApplication")
    )
    input_: capo_quicksight.types.describe_default_q_business_application_request.DescribeDefaultQBusinessApplicationRequest = {
        "aws_account_id": aws_account_id
    }
    if namespace is not None:
        input_["namespace"] = namespace

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