Skip to content

update_q_app_permissions async

update_q_app_permissions(
    instance_id: InstanceId,
    app_id: UUID,
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
    grant_permissions: Optional[PermissionsInputList] = None,
    revoke_permissions: Optional[PermissionsInputList] = None,
) -> UpdateQAppPermissionsOutput

Updates 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 permissions are being updated.

  • grant_permissions (Optional[PermissionsInputList], default: None ) –

    The list of permissions to grant for the Amazon Q App.

  • revoke_permissions (Optional[PermissionsInputList], default: None ) –

    The list of permissions to revoke for the Amazon Q App.

Raises:

Examples:

Grant permissions for the app

>>> await client.update_q_app_permissions(instance_id='01793661-ad73-4c7d-8eaa-1c95a10151c2', app_id='fe0acf86-49e5-4def-a0c2-40ce0cafee14', grant_permissions=[{'action': 'read', 'principal': '[email protected]'}])
Revoke permissions for the app
>>> await client.update_q_app_permissions(instance_id='01793661-ad73-4c7d-8eaa-1c95a10151c2', app_id='fe0acf86-49e5-4def-a0c2-40ce0cafee14', revoke_permissions=[{'action': 'read', 'principal': '[email protected]'}])
Source code in docs_src/capo_qapps/_services/async_q_apps.py
async def update_q_app_permissions(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    app_id: "capo_qapps.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
    grant_permissions: Optional[
        "capo_qapps.types.permissions_input_list.PermissionsInputList"
    ] = None,
    revoke_permissions: Optional[
        "capo_qapps.types.permissions_input_list.PermissionsInputList"
    ] = None,
) -> "capo_qapps.types.update_q_app_permissions_output.UpdateQAppPermissionsOutput":
    """<p>Updates 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 permissions are being updated.</p>
        grant_permissions: <p>The list of permissions to grant for the Amazon Q App.</p>
        revoke_permissions: <p>The list of permissions to revoke for the Amazon Q App.</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:
        Grant permissions for the app

        >>> await client.update_q_app_permissions(instance_id='01793661-ad73-4c7d-8eaa-1c95a10151c2', app_id='fe0acf86-49e5-4def-a0c2-40ce0cafee14', grant_permissions=[{'action': 'read', 'principal': '[email protected]'}])
        Revoke permissions for the app

        >>> await client.update_q_app_permissions(instance_id='01793661-ad73-4c7d-8eaa-1c95a10151c2', app_id='fe0acf86-49e5-4def-a0c2-40ce0cafee14', revoke_permissions=[{'action': 'read', 'principal': '[email protected]'}])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qapps.types.update_q_app_permissions_input.UpdateQAppPermissionsInput]",
    ) -> AsyncOperationResponse[
        "capo_qapps.types.update_q_app_permissions_output.UpdateQAppPermissionsOutput"
    ]:
        import capo_qapps._operations.q_apps_service.update_q_app_permissions

        (
            output,
            http_response,
        ) = await capo_qapps._operations.q_apps_service.update_q_app_permissions.async_update_q_app_permissions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateQAppPermissions")
    )
    input_: capo_qapps.types.update_q_app_permissions_input.UpdateQAppPermissionsInput = {
        "instance_id": instance_id,
        "app_id": app_id,
    }
    if grant_permissions is not None:
        input_["grant_permissions"] = grant_permissions
    if revoke_permissions is not None:
        input_["revoke_permissions"] = revoke_permissions

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