update_q_app_session_metadata ¶

def update_q_app_session_metadata(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    session_id: "capo_qapps.types.uuid.UUID",
    sharing_configuration: "capo_qapps.types.session_sharing_configuration.SessionSharingConfiguration",
    *,
    config_overrides: Optional[QAppsClientConfig] = None,
    session_name: Optional["capo_qapps.types.session_name.SessionName"] = None,
) -> "capo_qapps.types.update_q_app_session_metadata_output.UpdateQAppSessionMetadataOutput":
    """<p>Updates the configuration metadata of a session for a given Q App <code>sessionId</code>.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>
        session_id: <p>The unique identifier of the Q App session to update configuration for.</p>
        session_name: <p>The new name for the Q App session.</p>
        sharing_configuration: <p>The new sharing configuration for the Q App data collection session.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The requested operation could not be completed because it would exceed the service's quota or limit.</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:
        Updates an existing session metadata for an Amazon Q App

        >>> client.update_q_app_session_metadata(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', session_id='56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb', session_name='Trip itinerary collection session', sharing_configuration={'enabled': True, 'acceptResponses': True, 'revealCards': False})
    """

    def _handler(
        req: "OperationRequest[capo_qapps.types.update_q_app_session_metadata_input.UpdateQAppSessionMetadataInput]",
    ) -> OperationResponse[
        "capo_qapps.types.update_q_app_session_metadata_output.UpdateQAppSessionMetadataOutput"
    ]:
        import capo_qapps._operations.q_apps_service.update_q_app_session_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateQAppSessionMetadata")
    )
    input_: capo_qapps.types.update_q_app_session_metadata_input.UpdateQAppSessionMetadataInput = {
        "instance_id": instance_id,
        "session_id": session_id,
        "sharing_configuration": sharing_configuration,
    }
    if session_name is not None:
        input_["session_name"] = session_name

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