Skip to content

describe_q_app_permissions

describe_q_app_permissions(
    instance_id: InstanceId,
    app_id: UUID,
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> DescribeQAppPermissionsOutput

Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.

Parameters:

  • instance_id (InstanceId) –

    The unique identifier of the Amazon Q Business application environment instance.

  • app_id (UUID) –

    The unique identifier of the Amazon Q App for which to retrieve permissions.

Raises:

Examples:

Describe permissions for the app

>>> client.describe_q_app_permissions(instance_id='01793661-ad73-4c7d-8eaa-1c95a10151c2', app_id='fe0acf86-49e5-4def-a0c2-40ce0cafee14')
Source code in docs_src/capo_qapps/_services/q_apps.py
def describe_q_app_permissions(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    app_id: "capo_qapps.types.uuid.UUID",
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
) -> "capo_qapps.types.describe_q_app_permissions_output.DescribeQAppPermissionsOutput":
    """<p> Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>
        app_id: <p>The unique identifier of the Amazon Q App for which to retrieve permissions.</p>

    Raises:
        capo_qapps.errors.access_denied_exception.AccessDeniedException: <p>The client is not authorized to perform the requested operation.</p>
        capo_qapps.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred while processing the request.</p>
        capo_qapps.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_qapps.errors.throttling_exception.ThrottlingException: <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
        capo_qapps.errors.unauthorized_exception.UnauthorizedException: <p>The client is not authenticated or authorized to perform the requested operation.</p>
        capo_qapps.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by the service.</p>
        capo_qapps.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Describe permissions for the app

        >>> client.describe_q_app_permissions(instance_id='01793661-ad73-4c7d-8eaa-1c95a10151c2', app_id='fe0acf86-49e5-4def-a0c2-40ce0cafee14')
    """

    def _handler(
        req: "OperationRequest[capo_qapps.types.describe_q_app_permissions_input.DescribeQAppPermissionsInput]",
    ) -> OperationResponse[
        "capo_qapps.types.describe_q_app_permissions_output.DescribeQAppPermissionsOutput"
    ]:
        import capo_qapps._operations.q_apps_service.describe_q_app_permissions

        output, http_response = (
            capo_qapps._operations.q_apps_service.describe_q_app_permissions.describe_q_app_permissions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeQAppPermissions")
    )
    input_: capo_qapps.types.describe_q_app_permissions_input.DescribeQAppPermissionsInput = {
        "instance_id": instance_id,
        "app_id": app_id,
    }

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